angular2-universal - hapi-engine
Options
All
  • Public
  • Public/Protected
  • All
Menu

Build Status npm version Join the chat at https://gitter.im/angular/universal Issue Stats Issue Stats

Universal Angular 2

Universal Angular 2

Universal (isomorphic) JavaScript support for Angular 2.

Table of Contents

Getting Started

* NodeJS :: Universal Starter repo

* ASP.NET Core :: Universal Starter repo

Modules

Universal

Manage your application lifecycle and serialize changes while on the server to be sent to the client.

Documentation

Design Doc

Videos

Angular 2 Universal Patterns - ng-conf, May 2016
Angular 2 Universal Patterns

Angular Universal Source Code - ReadTheSource, January 2016
Angular Universal Source Code

Full Stack Angular 2 - AngularConnect, Oct 2015
Full Stack Angular 2

Angular 2 Server Rendering - Angular U, July 2015
Angular 2 Server Rendering

preboot.js

Control server-rendered page and transfer state before client-side web app loads to the client-side-app.

Best Practices

When building Universal components in Angular 2 there are a few things to keep in mind.

Note: Universal currently only works with router-deprecated

  • Know the difference between attributes and properties in relation to the DOM.
  • Don't manipulate the nativeElement directly. Use the Renderer. We do this to ensure that in any environment we're able to change our view.
    constructor(element: ElementRef, renderer: Renderer) {
renderer.setElementStyle(element.nativeElement, 'font-size', 'x-large');
}
  • Don't use any of the browser types provided in the global namespace such as navigator or document. Anything outside of Angular will not be detected when serializing your application into html. If you need access to these types please consider using DOM from "angular2/src/platform/dom/dom_adapter"
  • Keep your directives stateless as much as possible. For stateful directives, you may need to provide an attribute that reflects the corresponding property with an initial string value such as url in img tag. For our native <img src=""> element the src attribute is reflected as the src property of the element type HTMLImageElement.

What's in a name?

We believe that using the word "universal" is correct when referring to a JavaScript Application that runs in more environments than the browser. (inspired by Universal JavaScript)

License

MIT License

Index

External modules

External modules

"index"

"index":

"node_modules/angular2-express-engine/index"

"node_modules/angular2-express-engine/index":

"node_modules/angular2-express-engine/src/engine"

"node_modules/angular2-express-engine/src/engine":

ExpressEngineExtraOptions

ExpressEngineExtraOptions:

bootloader

bootloader: any

client

client: boolean

reuseProviders

reuseProviders: boolean

selector

selector: string

serializedCmp

serializedCmp: string

server

server: boolean

ExpressEngineConfig

ExpressEngineConfig: any

EXPRESS_PLATFORM

EXPRESS_PLATFORM: any

bootstrapApp

bootstrapApp: string

bootstrapButton

bootstrapButton: string

cache

cache: object

Type declaration

fs

fs: any

angularScript

  • angularScript(config: any): string

  • Parameters

    • config: any

    Returns string

bootstrapFunction

  • bootstrapFunction(config: any): string

  • Parameters

    • config: any

    Returns string

buildClientScripts

  • buildClientScripts(html: string, options: any): string

  • Parameters

    • html: string
    • options: any

    Returns string

disposeExpressAngularApp

  • disposeExpressAngularApp(): void

  • Returns void

disposeExpressPlatform

  • disposeExpressPlatform(): void

  • Returns void

expressEngine

  • Parameters

    Returns any

ng2Engine

  • Parameters

    Returns any

ng2ExpressEngine

  • Parameters

    Returns any

ng2engine

  • Parameters

    Returns any

prebootScript

  • prebootScript(config: any): string

  • Parameters

    • config: any

    Returns string

simpleReplace

  • Parameters

    Returns void

EXPRESS_ANGULAR_APP

EXPRESS_ANGULAR_APP: object

directives

directives: null

providers

providers: null

template

template: null

"node_modules/angular2-hapi-engine/index"

"node_modules/angular2-hapi-engine/index":

"node_modules/angular2-hapi-engine/src/engine"

"node_modules/angular2-hapi-engine/src/engine":

Runtime

Runtime:

constructor

  • Parameters

    Returns Runtime

bootstrapApp

bootstrapApp: string

bootstrapButton

bootstrapButton: string

options

options: HapiEngineConfig

angularScript

  • angularScript(config: any): string

  • Parameters

    • config: any

    Returns string

bootstrapFunction

  • bootstrapFunction(config: any): string

  • Parameters

    • config: any

    Returns string

buildClientScripts

  • buildClientScripts(html: string, options: any): string

  • Parameters

    • html: string
    • options: any

    Returns string

prebootScript

  • prebootScript(config: any): string

  • Parameters

    • config: any

    Returns string

render

  • render(template: string, context: any, done: Function): void

  • Parameters

    • template: string
    • context: any
    • done: Function

    Returns void

hapiEngine

hapiEngine:

constructor

  • Returns hapiEngine

helpers

helpers: any

partials

partials: any

compile

  • compile(template: any, options: any, next: any): any

  • Parameters

    • template: any
    • options: any
    • next: any

    Returns any

registerHelper

  • registerHelper(name: any, helper: any): void

  • Parameters

    • name: any
    • helper: any

    Returns void

registerPartial

  • registerPartial(name: any, partial: any): void

  • Parameters

    • name: any
    • partial: any

    Returns void

HapiEngineExtraOptions

HapiEngineExtraOptions:

bootloader

bootloader: any

client

client: boolean

reuseProviders

reuseProviders: boolean

selector

selector: string

serializedCmp

serializedCmp: string

server

server: boolean

HapiEngineConfig

HapiEngineConfig: any

HAPI_PLATFORM

HAPI_PLATFORM: any

disposeHapiAngularApp

  • disposeHapiAngularApp(): void

  • Returns void

disposeHapiPlatform

  • disposeHapiPlatform(): void

  • Returns void

HAPI_ANGULAR_APP

HAPI_ANGULAR_APP: object

directives

directives: null

providers

providers: null

template

template: null

"node_modules/angular2-hapi-engine/src/ts-hoek"

"node_modules/angular2-hapi-engine/src/ts-hoek":

applyToDefaults

  • applyToDefaults(defaults: any, options?: any, isNullOverride?: any): any

  • Parameters

    • defaults: any
    • Optional options: any
    • Optional isNullOverride: any

    Returns any

assert

  • assert(condition: any, ...args: Array<any>): void

  • Parameters

    • condition: any
    • Rest ...args: Array<any>

    Returns void

clone

  • clone(obj: any, seen?: any): any

  • Parameters

    • obj: any
    • Optional seen: any

    Returns any

merge

  • merge(target: any, source: any, isNullOverride: any, isMergeArrays: any): any

  • Parameters

    • target: any
    • source: any
    • isNullOverride: any
    • isMergeArrays: any

    Returns any

stringify

  • stringify(...args: Array<any>): any

  • Parameters

    • Rest ...args: Array<any>

    Returns any

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/Reflect"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/Reflect":

Reflect

Reflect:

BufferLike

BufferLike:

length

length: number

WorkerGlobalScope

WorkerGlobalScope: any

_Map

_Map: MapConstructor

_Set

_Set: SetConstructor

_WeakMap

_WeakMap: WeakMapConstructor

___Metadata__

___Metadata__: WeakMap<Object, Map<string | symbol, Map<any, any>>>

crypto

crypto: Crypto

functionPrototype

functionPrototype: any

global

global: any

module

module: any

require

require: Function

CreateMapPolyfill

  • CreateMapPolyfill(): any

  • Returns any

CreateSetPolyfill

  • CreateSetPolyfill(): any

  • Returns any

CreateWeakMapPolyfill

  • CreateWeakMapPolyfill(): any

  • Returns any

DecorateConstructor

  • DecorateConstructor(decorators: ClassDecorator[], target: Function): Function

  • Parameters

    • decorators: ClassDecorator[]
    • target: Function

    Returns Function

DecoratePropertyWithDescriptor

  • DecoratePropertyWithDescriptor(decorators: MethodDecorator[], target: Object, propertyKey: string | symbol, descriptor: PropertyDescriptor): PropertyDescriptor

  • Parameters

    • decorators: MethodDecorator[]
    • target: Object
    • propertyKey: string | symbol
    • descriptor: PropertyDescriptor

    Returns PropertyDescriptor

DecoratePropertyWithoutDescriptor

  • DecoratePropertyWithoutDescriptor(decorators: PropertyDecorator[], target: Object, propertyKey: string | symbol): void

  • Parameters

    • decorators: PropertyDecorator[]
    • target: Object
    • propertyKey: string | symbol

    Returns void

GetOrCreateMetadataMap

  • GetOrCreateMetadataMap(target: Object, targetKey: string | symbol, create: boolean): Map<any, any>

  • Parameters

    • target: Object
    • targetKey: string | symbol
    • create: boolean

    Returns Map<any, any>

GetPrototypeOf

  • GetPrototypeOf(O: any): Object

  • Parameters

    • O: any

    Returns Object

IsArray

  • IsArray(x: any): boolean

  • Parameters

    • x: any

    Returns boolean

IsConstructor

  • IsConstructor(x: any): boolean

  • Parameters

    • x: any

    Returns boolean

IsObject

  • IsObject(x: any): boolean

  • Parameters

    • x: any

    Returns boolean

IsSymbol

  • IsSymbol(x: any): boolean

  • Parameters

    • x: any

    Returns boolean

IsUndefined

  • IsUndefined(x: any): boolean

  • Parameters

    • x: any

    Returns boolean

OrdinaryDefineOwnMetadata

  • OrdinaryDefineOwnMetadata(MetadataKey: any, MetadataValue: any, O: Object, P: string | symbol): void

  • Parameters

    • MetadataKey: any
    • MetadataValue: any
    • O: Object
    • P: string | symbol

    Returns void

OrdinaryGetMetadata

  • OrdinaryGetMetadata(MetadataKey: any, O: Object, P: string | symbol): any

  • Parameters

    • MetadataKey: any
    • O: Object
    • P: string | symbol

    Returns any

OrdinaryGetOwnMetadata

  • OrdinaryGetOwnMetadata(MetadataKey: any, O: Object, P: string | symbol): any

  • Parameters

    • MetadataKey: any
    • O: Object
    • P: string | symbol

    Returns any

OrdinaryHasMetadata

  • OrdinaryHasMetadata(MetadataKey: any, O: Object, P: string | symbol): boolean

  • Parameters

    • MetadataKey: any
    • O: Object
    • P: string | symbol

    Returns boolean

OrdinaryHasOwnMetadata

  • OrdinaryHasOwnMetadata(MetadataKey: any, O: Object, P: string | symbol): boolean

  • Parameters

    • MetadataKey: any
    • O: Object
    • P: string | symbol

    Returns boolean

OrdinaryMetadataKeys

  • OrdinaryMetadataKeys(O: Object, P: string | symbol): any[]

  • Parameters

    • O: Object
    • P: string | symbol

    Returns any[]

OrdinaryOwnMetadataKeys

  • OrdinaryOwnMetadataKeys(target: Object, targetKey: string | symbol): any[]

  • Parameters

    • target: Object
    • targetKey: string | symbol

    Returns any[]

ToPropertyKey

  • ToPropertyKey(value: any): string | symbol

  • Parameters

    • value: any

    Returns string | symbol

decorate

  • decorate(decorators: ClassDecorator[], target: Function): Function
  • decorate(decorators: function | function, target: Object, targetKey: string | symbol, descriptor?: PropertyDescriptor): PropertyDescriptor

  • Applies a set of decorators to a target object.

    remarks

    Decorators are applied in reverse order of their positions in the array.

    example
    class C { }

// constructor
C = Reflect.decorate(decoratorsArray, C);

    Parameters

    • decorators: ClassDecorator[]

      An array of decorators.

    • target: Function

      The target object.

    Returns Function

    The result of applying the provided decorators.

  • Applies a set of decorators to a property of a target object.

    remarks

    Decorators are applied in reverse order.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod() { }
    method() { }
}

// property (on constructor)
Reflect.decorate(decoratorsArray, C, "staticProperty");

// property (on prototype)
Reflect.decorate(decoratorsArray, C.prototype, "property");

// method (on constructor)
Object.defineProperty(C, "staticMethod",
    Reflect.decorate(decoratorsArray, C, "staticMethod",
        Object.getOwnPropertyDescriptor(C, "staticMethod")));

// method (on prototype)
Object.defineProperty(C.prototype, "method",
    Reflect.decorate(decoratorsArray, C.prototype, "method",
        Object.getOwnPropertyDescriptor(C.prototype, "method")));

    Parameters

    • decorators: function | function

      An array of decorators.

    • target: Object

      The target object.

    • targetKey: string | symbol

      (Optional) The property key to decorate.

    • Optional descriptor: PropertyDescriptor

      A property descriptor

    Returns PropertyDescriptor

defineMetadata

  • defineMetadata(metadataKey: any, metadataValue: any, target: Object): void
  • defineMetadata(metadataKey: any, metadataValue: any, target: Object, targetKey: string | symbol): void

  • Define a unique metadata entry on the target.

    example
    class C {
}

// constructor
Reflect.defineMetadata("custom:annotation", options, C);

// decorator factory as metadata-producing annotation.
function MyAnnotation(options): ClassDecorator {
    return target => Reflect.defineMetadata("custom:annotation", options, target);
}

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • metadataValue: any

      A value that contains attached metadata.

    • target: Object

      The target object on which to define metadata.

    Returns void

  • Define a unique metadata entry on the target.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
Reflect.defineMetadata("custom:annotation", Number, C, "staticProperty");

// property (on prototype)
Reflect.defineMetadata("custom:annotation", Number, C.prototype, "property");

// method (on constructor)
Reflect.defineMetadata("custom:annotation", Number, C, "staticMethod");

// method (on prototype)
Reflect.defineMetadata("custom:annotation", Number, C.prototype, "method");

// decorator factory as metadata-producing annotation.
function MyAnnotation(options): PropertyDecorator {
    return (target, key) => Reflect.defineMetadata("custom:annotation", options, target, key);
}

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • metadataValue: any

      A value that contains attached metadata.

    • target: Object

      The target object on which to define metadata.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns void

deleteMetadata

  • deleteMetadata(metadataKey: any, target: Object): boolean
  • deleteMetadata(metadataKey: any, target: Object, targetKey: string | symbol): boolean

  • Deletes the metadata entry from the target object with the provided key.

    example
    class C {
}

// constructor
result = Reflect.deleteMetadata("custom:annotation", C);

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    Returns boolean

    true if the metadata entry was found and deleted; otherwise, false.

  • Deletes the metadata entry from the target object with the provided key.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.deleteMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.deleteMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.deleteMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.deleteMetadata("custom:annotation", C.prototype, "method");

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns boolean

    true if the metadata entry was found and deleted; otherwise, false.

getMetadata

  • getMetadata(metadataKey: any, target: Object): any
  • getMetadata(metadataKey: any, target: Object, targetKey: string | symbol): any

  • Gets the metadata value for the provided metadata key on the target object or its prototype chain.

    example
    class C {
}

// constructor
result = Reflect.getMetadata("custom:annotation", C);

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    Returns any

    The metadata value for the metadata key if found; otherwise, undefined.

  • Gets the metadata value for the provided metadata key on the target object or its prototype chain.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.getMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.getMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.getMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.getMetadata("custom:annotation", C.prototype, "method");

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns any

    The metadata value for the metadata key if found; otherwise, undefined.

getMetadataKeys

  • getMetadataKeys(target: Object): any[]
  • getMetadataKeys(target: Object, targetKey: string | symbol): any[]

  • Gets the metadata keys defined on the target object or its prototype chain.

    example
    class C {
}

// constructor
result = Reflect.getMetadataKeys(C);

    Parameters

    • target: Object

      The target object on which the metadata is defined.

    Returns any[]

    An array of unique metadata keys.

  • Gets the metadata keys defined on the target object or its prototype chain.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.getMetadataKeys(C, "staticProperty");

// property (on prototype)
result = Reflect.getMetadataKeys(C.prototype, "property");

// method (on constructor)
result = Reflect.getMetadataKeys(C, "staticMethod");

// method (on prototype)
result = Reflect.getMetadataKeys(C.prototype, "method");

    Parameters

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns any[]

    An array of unique metadata keys.

getOwnMetadata

  • getOwnMetadata(metadataKey: any, target: Object): any
  • getOwnMetadata(metadataKey: any, target: Object, targetKey: string | symbol): any

  • Gets the metadata value for the provided metadata key on the target object.

    example
    class C {
}

// constructor
result = Reflect.getOwnMetadata("custom:annotation", C);

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    Returns any

    The metadata value for the metadata key if found; otherwise, undefined.

  • Gets the metadata value for the provided metadata key on the target object.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.getOwnMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.getOwnMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.getOwnMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.getOwnMetadata("custom:annotation", C.prototype, "method");

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns any

    The metadata value for the metadata key if found; otherwise, undefined.

getOwnMetadataKeys

  • getOwnMetadataKeys(target: Object): any[]
  • getOwnMetadataKeys(target: Object, targetKey: string | symbol): any[]

  • Gets the unique metadata keys defined on the target object.

    example
    class C {
}

// constructor
result = Reflect.getOwnMetadataKeys(C);

    Parameters

    • target: Object

      The target object on which the metadata is defined.

    Returns any[]

    An array of unique metadata keys.

  • Gets the unique metadata keys defined on the target object.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.getOwnMetadataKeys(C, "staticProperty");

// property (on prototype)
result = Reflect.getOwnMetadataKeys(C.prototype, "property");

// method (on constructor)
result = Reflect.getOwnMetadataKeys(C, "staticMethod");

// method (on prototype)
result = Reflect.getOwnMetadataKeys(C.prototype, "method");

    Parameters

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns any[]

    An array of unique metadata keys.

hasMetadata

  • hasMetadata(metadataKey: any, target: Object): boolean
  • hasMetadata(metadataKey: any, target: Object, targetKey: string | symbol): boolean

  • Gets a value indicating whether the target object or its prototype chain has the provided metadata key defined.

    example
    class C {
}

// constructor
result = Reflect.hasMetadata("custom:annotation", C);

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    Returns boolean

    true if the metadata key was defined on the target object or its prototype chain; otherwise, false.

  • Gets a value indicating whether the target object or its prototype chain has the provided metadata key defined.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.hasMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.hasMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.hasMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.hasMetadata("custom:annotation", C.prototype, "method");

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns boolean

    true if the metadata key was defined on the target object or its prototype chain; otherwise, false.

hasOwnMetadata

  • hasOwnMetadata(metadataKey: any, target: Object): boolean
  • hasOwnMetadata(metadataKey: any, target: Object, targetKey: string | symbol): boolean

  • Gets a value indicating whether the target object has the provided metadata key defined.

    example
    class C {
}

// constructor
result = Reflect.hasOwnMetadata("custom:annotation", C);

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    Returns boolean

    true if the metadata key was defined on the target object; otherwise, false.

  • Gets a value indicating whether the target object has the provided metadata key defined.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.hasOwnMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.hasOwnMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.hasOwnMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.hasOwnMetadata("custom:annotation", C.prototype, "method");

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns boolean

    true if the metadata key was defined on the target object; otherwise, false.

metadata

  • metadata(metadataKey: any, metadataValue: any): decorator

  • A default metadata decorator factory that can be used on a class, class member, or parameter.

    remarks

    If metadataKey is already defined for the target and target key, the metadataValue for that key will be overwritten.

    example
    // constructor
@Reflect.metadata(key, value)
class C {
}

// property (on constructor, TypeScript only)
class C {
    @Reflect.metadata(key, value)
    static staticProperty;
}

// property (on prototype, TypeScript only)
class C {
    @Reflect.metadata(key, value)
    property;
}

// method (on constructor)
class C {
    @Reflect.metadata(key, value)
    static staticMethod() { }
}

// method (on prototype)
class C {
    @Reflect.metadata(key, value)
    method() { }
}

    Parameters

    • metadataKey: any

      The key for the metadata entry.

    • metadataValue: any

      The value for the metadata entry.

    Returns decorator

    A decorator function.

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/harness"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/harness":

TestResults

TestResults:

failed

failed: [string, any]

passed

passed: string[]

printResults

  • Parameters

    Returns void

runTests

  • Parameters

    • fixture: any

    Returns TestResults

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-decorate"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-decorate":

ReflectDecorateExecutesDecoratorsInReverseOrderForFunctionOverload

  • ReflectDecorateExecutesDecoratorsInReverseOrderForFunctionOverload(): void

  • Returns void

ReflectDecorateExecutesDecoratorsInReverseOrderForPropertyDescriptorOverload

  • ReflectDecorateExecutesDecoratorsInReverseOrderForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecorateExecutesDecoratorsInReverseOrderForPropertyOverload

  • ReflectDecorateExecutesDecoratorsInReverseOrderForPropertyOverload(): void

  • Returns void

ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForFunctionOverload

  • ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForFunctionOverload(): void

  • Returns void

ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForPropertyDescriptorOverload

  • ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForPropertyOverload

  • ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForPropertyOverload(): void

  • Returns void

ReflectDecorateThrowsIfTargetArgumentNotFunctionForFunctionOverload

  • ReflectDecorateThrowsIfTargetArgumentNotFunctionForFunctionOverload(): void

  • Returns void

ReflectDecorateThrowsIfTargetArgumentNotObjectForPropertyDescriptorOverload

  • ReflectDecorateThrowsIfTargetArgumentNotObjectForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecorateThrowsIfTargetArgumentNotObjectForPropertyOverload

  • ReflectDecorateThrowsIfTargetArgumentNotObjectForPropertyOverload(): void

  • Returns void

ReflectDecoratorCorrectDescriptorInPipelineForPropertyDescriptorOverload

  • ReflectDecoratorCorrectDescriptorInPipelineForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecoratorCorrectNameInPipelineForPropertyDescriptorOverload

  • ReflectDecoratorCorrectNameInPipelineForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecoratorCorrectNameInPipelineForPropertyOverload

  • ReflectDecoratorCorrectNameInPipelineForPropertyOverload(): void

  • Returns void

ReflectDecoratorCorrectTargetInPipelineForFunctionOverload

  • ReflectDecoratorCorrectTargetInPipelineForFunctionOverload(): void

  • Returns void

ReflectDecoratorCorrectTargetInPipelineForPropertyDescriptorOverload

  • ReflectDecoratorCorrectTargetInPipelineForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecoratorCorrectTargetInPipelineForPropertyOverload

  • ReflectDecoratorCorrectTargetInPipelineForPropertyOverload(): void

  • Returns void

ReflectDecoratorPipelineForFunctionOverload

  • ReflectDecoratorPipelineForFunctionOverload(): void

  • Returns void

ReflectDecoratorPipelineForPropertyDescriptorOverload

  • ReflectDecoratorPipelineForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecoratorPipelineForPropertyOverload

  • ReflectDecoratorPipelineForPropertyOverload(): void

  • Returns void

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-definemetadata"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-definemetadata":

ReflectDefineMetadataInvalidTarget

  • ReflectDefineMetadataInvalidTarget(): void

  • Returns void

ReflectDefineMetadataValidTargetWithTargetKey

  • ReflectDefineMetadataValidTargetWithTargetKey(): void

  • Returns void

ReflectDefineMetadataValidTargetWithoutTargetKey

  • ReflectDefineMetadataValidTargetWithoutTargetKey(): void

  • Returns void

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-deletemetadata"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-deletemetadata":

ReflectDeleteMetadataInvalidTarget

  • ReflectDeleteMetadataInvalidTarget(): void

  • Returns void

ReflectDeleteMetadataWhenDefinedOnPrototypeWithoutTargetKey

  • ReflectDeleteMetadataWhenDefinedOnPrototypeWithoutTargetKey(): void

  • Returns void

ReflectDeleteMetadataWhenDefinedWithoutTargetKey

  • ReflectDeleteMetadataWhenDefinedWithoutTargetKey(): void

  • Returns void

ReflectDeleteMetadataWhenNotDefinedWithoutTargetKey

  • ReflectDeleteMetadataWhenNotDefinedWithoutTargetKey(): void

  • Returns void

ReflectHasOwnMetadataAfterDeleteMetadata

  • ReflectHasOwnMetadataAfterDeleteMetadata(): void

  • Returns void

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-getmetadata"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-getmetadata":

ReflectGetMetadataInvalidTarget

  • ReflectGetMetadataInvalidTarget(): void

  • Returns void

ReflectGetMetadataWithTargetKeyWhenDefined

  • ReflectGetMetadataWithTargetKeyWhenDefined(): void

  • Returns void

ReflectGetMetadataWithTargetKeyWhenDefinedOnPrototype

  • ReflectGetMetadataWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetMetadataWithTargetKeyWhenNotDefined

  • ReflectGetMetadataWithTargetKeyWhenNotDefined(): void

  • Returns void

ReflectGetMetadataWithoutTargetKeyWhenDefined

  • ReflectGetMetadataWithoutTargetKeyWhenDefined(): void

  • Returns void

ReflectGetMetadataWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectGetMetadataWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetMetadataWithoutTargetKeyWhenNotDefined

  • ReflectGetMetadataWithoutTargetKeyWhenNotDefined(): void

  • Returns void

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys":

ReflectGetMetadataKeysInvalidTarget

  • ReflectGetMetadataKeysInvalidTarget(): void

  • Returns void

ReflectGetMetadataKeysOrderAfterRedefineWithTargetKey

  • ReflectGetMetadataKeysOrderAfterRedefineWithTargetKey(): void

  • Returns void

ReflectGetMetadataKeysOrderAfterRedefineWithoutTargetKey

  • ReflectGetMetadataKeysOrderAfterRedefineWithoutTargetKey(): void

  • Returns void

ReflectGetMetadataKeysOrderWithTargetKeyWhenDefinedOnPrototype

  • ReflectGetMetadataKeysOrderWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetMetadataKeysOrderWithoutTargetKey

  • ReflectGetMetadataKeysOrderWithoutTargetKey(): void

  • Returns void

ReflectGetMetadataKeysOrderWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectGetMetadataKeysOrderWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetMetadataKeysWithTargetKeyWhenDefined

  • ReflectGetMetadataKeysWithTargetKeyWhenDefined(): void

  • Returns void

ReflectGetMetadataKeysWithTargetKeyWhenDefinedOnPrototype

  • ReflectGetMetadataKeysWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetMetadataKeysWithTargetKeyWhenNotDefined

  • ReflectGetMetadataKeysWithTargetKeyWhenNotDefined(): void

  • Returns void

ReflectGetMetadataKeysWithoutTargetKeyWhenDefined

  • ReflectGetMetadataKeysWithoutTargetKeyWhenDefined(): void

  • Returns void

ReflectGetMetadataKeysWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectGetMetadataKeysWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetMetadataKeysWithoutTargetKeyWhenNotDefined

  • ReflectGetMetadataKeysWithoutTargetKeyWhenNotDefined(): void

  • Returns void

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-getownmetadata"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-getownmetadata":

ReflectGetOwnMetadataInvalidTarget

  • ReflectGetOwnMetadataInvalidTarget(): void

  • Returns void

ReflectGetOwnMetadataWithTargetKeyWhenDefined

  • ReflectGetOwnMetadataWithTargetKeyWhenDefined(): void

  • Returns void

ReflectGetOwnMetadataWithTargetKeyWhenDefinedOnPrototype

  • ReflectGetOwnMetadataWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetOwnMetadataWithTargetKeyWhenNotDefined

  • ReflectGetOwnMetadataWithTargetKeyWhenNotDefined(): void

  • Returns void

ReflectGetOwnMetadataWithoutTargetKeyWhenDefined

  • ReflectGetOwnMetadataWithoutTargetKeyWhenDefined(): void

  • Returns void

ReflectGetOwnMetadataWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectGetOwnMetadataWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetOwnMetadataWithoutTargetKeyWhenNotDefined

  • ReflectGetOwnMetadataWithoutTargetKeyWhenNotDefined(): void

  • Returns void

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys":

ReflectGetOwnMetadataKeysKeysInvalidTarget

  • ReflectGetOwnMetadataKeysKeysInvalidTarget(): void

  • Returns void

ReflectGetOwnMetadataKeysOrderAfterRedefineWithTargetKey

  • ReflectGetOwnMetadataKeysOrderAfterRedefineWithTargetKey(): void

  • Returns void

ReflectGetOwnMetadataKeysOrderAfterRedefineWithoutTargetKey

  • ReflectGetOwnMetadataKeysOrderAfterRedefineWithoutTargetKey(): void

  • Returns void

ReflectGetOwnMetadataKeysOrderWithoutTargetKey

  • ReflectGetOwnMetadataKeysOrderWithoutTargetKey(): void

  • Returns void

ReflectGetOwnMetadataKeysWithTargetKeyWhenDefined

  • ReflectGetOwnMetadataKeysWithTargetKeyWhenDefined(): void

  • Returns void

ReflectGetOwnMetadataKeysWithTargetKeyWhenDefinedOnPrototype

  • ReflectGetOwnMetadataKeysWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetOwnMetadataKeysWithTargetKeyWhenNotDefined

  • ReflectGetOwnMetadataKeysWithTargetKeyWhenNotDefined(): void

  • Returns void

ReflectGetOwnMetadataKeysWithoutTargetKeyWhenDefined

  • ReflectGetOwnMetadataKeysWithoutTargetKeyWhenDefined(): void

  • Returns void

ReflectGetOwnMetadataKeysWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectGetOwnMetadataKeysWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetOwnMetadataKeysWithoutTargetKeyWhenNotDefined

  • ReflectGetOwnMetadataKeysWithoutTargetKeyWhenNotDefined(): void

  • Returns void

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-hasmetadata"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-hasmetadata":

ReflectHasMetadataInvalidTarget

  • ReflectHasMetadataInvalidTarget(): void

  • Returns void

ReflectHasMetadataWithTargetKeyWhenDefined

  • ReflectHasMetadataWithTargetKeyWhenDefined(): void

  • Returns void

ReflectHasMetadataWithTargetKeyWhenDefinedOnPrototype

  • ReflectHasMetadataWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectHasMetadataWithTargetKeyWhenNotDefined

  • ReflectHasMetadataWithTargetKeyWhenNotDefined(): void

  • Returns void

ReflectHasMetadataWithoutTargetKeyWhenDefined

  • ReflectHasMetadataWithoutTargetKeyWhenDefined(): void

  • Returns void

ReflectHasMetadataWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectHasMetadataWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectHasMetadataWithoutTargetKeyWhenNotDefined

  • ReflectHasMetadataWithoutTargetKeyWhenNotDefined(): void

  • Returns void

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata":

ReflectHasOwnMetadataInvalidTarget

  • ReflectHasOwnMetadataInvalidTarget(): void

  • Returns void

ReflectHasOwnMetadataWithTargetKeyWhenDefined

  • ReflectHasOwnMetadataWithTargetKeyWhenDefined(): void

  • Returns void

ReflectHasOwnMetadataWithTargetKeyWhenDefinedOnPrototype

  • ReflectHasOwnMetadataWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectHasOwnMetadataWithTargetKeyWhenNotDefined

  • ReflectHasOwnMetadataWithTargetKeyWhenNotDefined(): void

  • Returns void

ReflectHasOwnMetadataWithoutTargetKeyWhenDefined

  • ReflectHasOwnMetadataWithoutTargetKeyWhenDefined(): void

  • Returns void

ReflectHasOwnMetadataWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectHasOwnMetadataWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectHasOwnMetadataWithoutTargetKeyWhenNotDefined

  • ReflectHasOwnMetadataWithoutTargetKeyWhenNotDefined(): void

  • Returns void

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-metadata"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/reflect/reflect-metadata":

ReflectMetadataDecoratorSetsMetadataOnTargetWithTargetKey

  • ReflectMetadataDecoratorSetsMetadataOnTargetWithTargetKey(): void

  • Returns void

ReflectMetadataDecoratorSetsMetadataOnTargetWithoutTargetKey

  • ReflectMetadataDecoratorSetsMetadataOnTargetWithoutTargetKey(): void

  • Returns void

ReflectMetadataDecoratorThrowsWithInvalidTargetWithTargetKey

  • ReflectMetadataDecoratorThrowsWithInvalidTargetWithTargetKey(): void

  • Returns void

ReflectMetadataDecoratorThrowsWithInvalidTargetWithoutTargetKey

  • ReflectMetadataDecoratorThrowsWithInvalidTargetWithoutTargetKey(): void

  • Returns void

ReflectMetadataReturnsDecoratorFunction

  • ReflectMetadataReturnsDecoratorFunction(): void

  • Returns void

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/run"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/run":

results

results: TestResults

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/spec"

"node_modules/angular2-universal-polyfills/node_modules/reflect-metadata/test/spec":

"node_modules/angular2-universal-polyfills/src/dev"

"node_modules/angular2-universal-polyfills/src/dev":

"node_modules/angular2-universal-polyfills/src/ie"

"node_modules/angular2-universal-polyfills/src/ie":

"node_modules/angular2-universal-polyfills/src/polyfills-browser"

"node_modules/angular2-universal-polyfills/src/polyfills-browser":

"node_modules/angular2-universal-polyfills/src/polyfills-node"

"node_modules/angular2-universal-polyfills/src/polyfills-node":

"node_modules/angular2-universal-polyfills/src/prod"

"node_modules/angular2-universal-polyfills/src/prod":

"node_modules/angular2-universal-polyfills/src/test"

"node_modules/angular2-universal-polyfills/src/test":

"node_modules/angular2-universal-polyfills/src/zone-browser"

"node_modules/angular2-universal-polyfills/src/zone-browser":

"node_modules/angular2-universal-polyfills/src/zone-node/index"

"node_modules/angular2-universal-polyfills/src/zone-node/index":

"node_modules/angular2-universal/src/browser/bootstrap"

"node_modules/angular2-universal/src/browser/bootstrap":

prebootCompleted

prebootCompleted: boolean

bootstrap

  • bootstrap(appComponentType: any, appProviders?: Array<Type | Provider | any | any[]>): Promise<ComponentRef<any>>

  • Parameters

    • appComponentType: any
    • Default value appProviders: Array<Type | Provider | any | any[]> = null

    Returns Promise<ComponentRef<any>>

prebootComplete

  • prebootComplete(value?: any): any

  • Parameters

    • Optional value: any

    Returns any

"node_modules/angular2-universal/src/browser/browser"

"node_modules/angular2-universal/src/browser/browser":

"node_modules/angular2-universal/src/browser/env"

"node_modules/angular2-universal/src/browser/env":

isBrowser

isBrowser: boolean

isNode

isNode: boolean

"node_modules/angular2-universal/src/browser/http"

"node_modules/angular2-universal/src/browser/http":

BROWSER_HTTP_PROVIDERS

BROWSER_HTTP_PROVIDERS: Array<any>

BROWSER_JSONP_PROVIDERS

BROWSER_JSONP_PROVIDERS: Array<any>

"node_modules/angular2-universal/src/browser/index"

"node_modules/angular2-universal/src/browser/index":

"node_modules/angular2-universal/src/browser/ng_preload_cache"

"node_modules/angular2-universal/src/browser/ng_preload_cache":

NgPreloadCacheHttp

NgPreloadCacheHttp:

constructor

  • new NgPreloadCacheHttp(_backend: ConnectionBackend, _defaultOptions: RequestOptions): NgPreloadCacheHttp

  • Parameters

    • _backend: ConnectionBackend
    • _defaultOptions: RequestOptions

    Returns NgPreloadCacheHttp

_backend

_backend: ConnectionBackend

_defaultOptions

_defaultOptions: RequestOptions

prime

prime: boolean

delete

  • delete(url: string, options: any): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • options: any

    Returns Observable<Response> | EventEmitter<any>

get

  • get(url: string, options: any): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • options: any

    Returns Observable<Response> | EventEmitter<any>

head

  • head(url: string, options: any): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • options: any

    Returns Observable<Response> | EventEmitter<any>

patch

  • patch(url: string, body: string, options: any): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • body: string
    • options: any

    Returns Observable<Response> | EventEmitter<any>

post

  • post(url: string, body: string, options: any): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • body: string
    • options: any

    Returns Observable<Response> | EventEmitter<any>

preload

  • preload(method: any): Observable<any> | EventEmitter<any>

  • Parameters

    • method: any

    Returns Observable<any> | EventEmitter<any>

put

  • put(url: string, body: string, options: any): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • body: string
    • options: any

    Returns Observable<Response> | EventEmitter<any>

request

  • request(url: string, options: any): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • options: any

    Returns Observable<Response> | EventEmitter<any>

NG_PRELOAD_CACHE_PROVIDERS

NG_PRELOAD_CACHE_PROVIDERS: Array<any>

"node_modules/angular2-universal/src/browser/platform"

"node_modules/angular2-universal/src/browser/platform":

"node_modules/angular2-universal/src/browser/router"

"node_modules/angular2-universal/src/browser/router":

BROWSER_ROUTER_PROVIDERS

BROWSER_ROUTER_PROVIDERS: Array<any>

"node_modules/angular2-universal/src/common/cookie"

"node_modules/angular2-universal/src/common/cookie":

Cookie

Cookie:

An abstract class for handling cookies.

get

  • get(key?: string): string

  • Parameters

    • Optional key: string

    Returns string

remove

  • Parameters

    Returns any

set

  • Parameters

    Returns void

toJSON

  • toJSON(): Object

  • Returns Object

CookieAttributes

CookieAttributes:

domain

domain: string

expires

expires: number | Date

path

path: string

secure

secure: boolean

"node_modules/angular2-universal/src/common/http"

"node_modules/angular2-universal/src/common/http":

"node_modules/angular2-universal/src/common/index"

"node_modules/angular2-universal/src/common/index":

"node_modules/angular2-universal/src/common/localStorage"

"node_modules/angular2-universal/src/common/localStorage":

LocalStorage

LocalStorage:

The Storage abstract class of the Web Storage API provides access to local storage for a particular domain.

length

length: number

clear

  • clear(): void

  • Returns void

getItem

  • getItem(): string

  • Returns string

key

  • key(index: number): string

  • Parameters

    • index: number

    Returns string

removeItem

  • removeItem(key: string): void

  • Parameters

    • key: string

    Returns void

setItem

  • setItem(key: string, value: string): void

  • Parameters

    • key: string
    • value: string

    Returns void

toJSON

  • toJSON(): Object

  • Returns Object

"node_modules/angular2-universal/src/common/title"

"node_modules/angular2-universal/src/common/title":

Title

Title:

An abstract service that can be used to get and set the title of a current HTML document.

getTitle

  • getTitle(): string

  • Returns string

setTitle

  • setTitle(title: string): void

  • Parameters

    • title: string

    Returns void

"node_modules/angular2-universal/src/common/tokens/index"

"node_modules/angular2-universal/src/common/tokens/index":

BASE_URL

BASE_URL: OpaqueToken

COOKIE_KEY

COOKIE_KEY: OpaqueToken

ORIGIN_URL

ORIGIN_URL: OpaqueToken

PRIME_CACHE

PRIME_CACHE: OpaqueToken

REQUEST_URL

REQUEST_URL: OpaqueToken

"node_modules/angular2-universal/src/global"

"node_modules/angular2-universal/src/global":

___global

  • ___global(m: any): void

  • Parameters

    • m: any

    Returns void

"node_modules/angular2-universal/src/node/bootloader"

"node_modules/angular2-universal/src/node/bootloader":

Bootloader

Bootloader:

constructor

applicationRef

applicationRef: any

disposed

disposed: boolean

pending

pending: boolean

pendingDisposed

pendingDisposed: boolean

platformRef

platformRef: any

_applicationAll

  • Parameters

    Returns Promise<ConfigRefs>

_async

  • Parameters

    Returns Promise<ConfigRefs>

_bootstrapAll

  • _bootstrapAll(Components?: Array<any>, componentProviders?: Array<any>): Promise<Array<any>>

  • Parameters

    • Optional Components: Array<any>
    • Optional componentProviders: Array<any>

    Returns Promise<Array<any>>

_deprecated

  • _deprecated(config: any): any

  • Parameters

    • config: any

    Returns any

_preboot

  • Parameters

    Returns Promise<ConfigRefs>

application

  • application(document?: any, providers?: any): any

  • Parameters

    • Optional document: any
    • Optional providers: any

    Returns any

bootstrap

  • bootstrap(Component?: any | Array<any>): Promise<any>

  • Parameters

    • Optional Component: any | Array<any>

    Returns Promise<any>

dispose

  • dispose(): void

  • Returns void

document

  • document(document?: string | Object): Object

  • Parameters

    • Default value document: string | Object = null

    Returns Object

platform

  • platform(providers?: any): PlatformRef

  • Parameters

    • Optional providers: any

    Returns PlatformRef

serialize

  • serialize(Component?: any | Array<any>): Promise<any>

  • Parameters

    • Optional Component: any | Array<any>

    Returns Promise<any>

serializeApplication

  • serializeApplication(config?: AppConfig | any, providers?: Array<any>): Promise<any> | any

  • Parameters

    • Optional config: AppConfig | any
    • Optional providers: Array<any>

    Returns Promise<any> | any

applicationRefToString

  • applicationRefToString(applicationRefs: any): string

  • Parameters

    • applicationRefs: any

    Returns string

create

  • Parameters

    • config: any

    Returns Bootloader

parseDocument

  • parseDocument(document: string): Object

  • Parameters

    • document: string

    Returns Object

parseFragment

  • parseFragment(document: string): Object

  • Parameters

    • document: string

    Returns Object

serializeDocument

  • serializeDocument(document: Object): string

  • Parameters

    • document: Object

    Returns string

_config

_config: object

async

async: boolean

preboot

preboot: boolean

AppConfig

AppConfig:

directives

directives: Array<any>

providers

providers: Array<any>

template

template: string

BootloaderConfig

BootloaderConfig:

async

async: boolean

beautify

beautify: boolean

bootloader

bootloader: Bootloader | any

component

component: any

componentProviders

componentProviders: Array<any>

directives

directives: Array<any>

maxZoneTurns

maxZoneTurns: number

ngDoCheck

ngDoCheck: function

Type declaration

    • (config: ConfigRef, ngZone: NgZone): boolean

    • Parameters

      Returns boolean

ngOnInit

ngOnInit: function

Type declaration

ngOnRendered

ngOnRendered: function

Type declaration

    • (rendered?: string): string | any | Promise<any>

    • Parameters

      • Optional rendered: string

      Returns string | any | Promise<any>

ngOnStable

ngOnStable: function

Type declaration

platformProviders

platformProviders: Array<any>

preboot

preboot: boolean | any

precache

precache: boolean

prime

prime: boolean

primeCache

primeCache: boolean

providers

providers: Array<any>

template

template: string

ConfigRef

ConfigRef: object

Type declaration

  • applicationRef: ApplicationRef
  • componentRef: ComponentRef<any>

ConfigRefs

ConfigRefs: Array<ConfigRef>

DOM

DOM: any

bootloader

  • Parameters

    Returns Bootloader

"node_modules/angular2-universal/src/node/directives/index"

"node_modules/angular2-universal/src/node/directives/index":

NODE_DIRECTIVES

NODE_DIRECTIVES: Array<any>

NODE_FORM_DIRECTIVES

NODE_FORM_DIRECTIVES: Array<any>

NODE_PLATFORM_DIRECTIVES

NODE_PLATFORM_DIRECTIVES: Array<any>

"node_modules/angular2-universal/src/node/directives/node_form"

"node_modules/angular2-universal/src/node/directives/node_form":

NodeForm

NodeForm:

constructor

  • new NodeForm(element: ElementRef, renderer: Renderer, appLocation?: string): NodeForm

  • Parameters

    • element: ElementRef
    • renderer: Renderer
    • Optional appLocation: string

    Returns NodeForm

APP_LOCATION

APP_LOCATION: OpaqueToken

CONST_EXPR

  • CONST_EXPR(v: any): any

  • Parameters

    • v: any

    Returns any

"node_modules/angular2-universal/src/node/directives/node_universal_styles"

"node_modules/angular2-universal/src/node/directives/node_universal_styles":

NodeUniversalStyles

NodeUniversalStyles:

constructor

  • new NodeUniversalStyles(el: ElementRef, domSharedStylesHost: DomSharedStylesHost): NodeUniversalStyles

  • Parameters

    • el: ElementRef
    • domSharedStylesHost: DomSharedStylesHost

    Returns NodeUniversalStyles

domSharedStylesHost

domSharedStylesHost: DomSharedStylesHost

el

el: ElementRef

"node_modules/angular2-universal/src/node/env"

"node_modules/angular2-universal/src/node/env":

isBrowser

isBrowser: boolean

isNode

isNode: boolean

"node_modules/angular2-universal/src/node/helper"

"node_modules/angular2-universal/src/node/helper":

directiveResolver

directiveResolver: any

arrayFlattenTree

  • arrayFlattenTree(children: any[], arr: any[]): any[]

  • Parameters

    • children: any[]
    • arr: any[]

    Returns any[]

cssHyphenate

  • cssHyphenate(propertyName: string): string

  • Parameters

    • propertyName: string

    Returns string

escapeRegExp

  • escapeRegExp(str: any): string

  • Parameters

    • str: any

    Returns string

queryParamsToBoolean

  • queryParamsToBoolean(query: any): any

  • Parameters

    • query: any

    Returns any

selectorRegExpFactory

  • selectorRegExpFactory(selector: string): RegExp

  • Parameters

    • selector: string

    Returns RegExp

selectorResolver

  • selectorResolver(componentType: any): string

  • Parameters

    • componentType: any

    Returns string

serverDirectiveResolver

  • serverDirectiveResolver(componentType: any): any

  • Parameters

    • componentType: any

    Returns any

showDebug

  • showDebug(options?: object): string

  • Parameters

    • Default value options: object = {}

    Returns string

stringToBoolean

  • stringToBoolean(txt: any): boolean | string

  • Parameters

    • txt: any

    Returns boolean | string

stringify

  • stringify(obj: any, replacer?: any, spaces?: number): string

  • Parameters

    • obj: any
    • Default value replacer: any = null
    • Default value spaces: number = 2

    Returns string

"node_modules/angular2-universal/src/node/http/index"

"node_modules/angular2-universal/src/node/http/index":

HTTP_PROVIDERS

HTTP_PROVIDERS: Array<any>

NODE_HTTP_PROVIDERS

NODE_HTTP_PROVIDERS: Array<any>

NODE_HTTP_PROVIDERS_COMMON

NODE_HTTP_PROVIDERS_COMMON: Array<any>

NODE_JSONP_PROVIDERS

NODE_JSONP_PROVIDERS: Array<any>

NODE_PRELOAD_CACHE_HTTP_PROVIDERS

NODE_PRELOAD_CACHE_HTTP_PROVIDERS: Array<any>

"node_modules/angular2-universal/src/node/http/node_http"

"node_modules/angular2-universal/src/node/http/node_http":

NodeBackend

NodeBackend:

constructor

  • new NodeBackend(_baseResponseOptions: ResponseOptions, _ngZone: NgZone, _baseUrl: string, _originUrl: string): NodeBackend

  • Parameters

    • _baseResponseOptions: ResponseOptions
    • _ngZone: NgZone
    • _baseUrl: string
    • _originUrl: string

    Returns NodeBackend

_baseResponseOptions

_baseResponseOptions: ResponseOptions

_baseUrl

_baseUrl: string

_ngZone

_ngZone: NgZone

_originUrl

_originUrl: string

createConnection

  • Parameters

    • request: Request

    Returns NodeConnection

NodeConnection

NodeConnection:

constructor

  • new NodeConnection(req: Request, baseResponseOptions: ResponseOptions, ngZone: NgZone, originUrl?: string, baseUrl?: string, cookie?: Cookie, cookieKey?: any): NodeConnection

  • Parameters

    • req: Request
    • baseResponseOptions: ResponseOptions
    • ngZone: NgZone
    • Default value originUrl: string = ""
    • Optional baseUrl: string
    • Optional cookie: Cookie
    • Optional cookieKey: any

    Returns NodeConnection

readyState

readyState: ReadyState

request

request: Request

response

response: Observable<Response> | Observable<any>

NodeJSONPConnection

NodeJSONPConnection:

constructor

  • new NodeJSONPConnection(req: Request, baseResponseOptions: ResponseOptions, ngZone: NgZone, originUrl?: string, baseUrl?: string): NodeJSONPConnection

  • Parameters

    • req: Request
    • baseResponseOptions: ResponseOptions
    • ngZone: NgZone
    • Default value originUrl: string = ""
    • Optional baseUrl: string

    Returns NodeJSONPConnection

readyState

readyState: ReadyState

request

request: Request

response

response: Observable<Response> | Observable<any>

NodeJsonpBackend

NodeJsonpBackend:

constructor

  • new NodeJsonpBackend(_baseResponseOptions: ResponseOptions, _ngZone: NgZone, _baseUrl: string, _originUrl: string): NodeJsonpBackend

  • Parameters

    • _baseResponseOptions: ResponseOptions
    • _ngZone: NgZone
    • _baseUrl: string
    • _originUrl: string

    Returns NodeJsonpBackend

_baseResponseOptions

_baseResponseOptions: ResponseOptions

_baseUrl

_baseUrl: string

_ngZone

_ngZone: NgZone

_originUrl

_originUrl: string

createConnection

  • Parameters

    • request: Request

    Returns NodeConnection

JSONP_ERR_WRONG_METHOD

JSONP_ERR_WRONG_METHOD: string

"node_modules/angular2-universal/src/node/http/preload_cache"

"node_modules/angular2-universal/src/node/http/preload_cache":

NgPreloadCacheHttp

NgPreloadCacheHttp:

constructor

  • new NgPreloadCacheHttp(_backend: ConnectionBackend, _defaultOptions: RequestOptions, _ngZone: NgZone, prime?: boolean): NgPreloadCacheHttp

  • Parameters

    • _backend: ConnectionBackend
    • _defaultOptions: RequestOptions
    • _ngZone: NgZone
    • Optional prime: boolean

    Returns NgPreloadCacheHttp

_activeNode

_activeNode: any

_async

_async: number

_backend

_backend: ConnectionBackend

_callId

_callId: number

_defaultOptions

_defaultOptions: RequestOptions

_ngZone

_ngZone: NgZone

_rootNode

_rootNode: any

prime

prime: boolean

delete

  • delete(url: string, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • Optional options: RequestOptionsArgs

    Returns Observable<Response> | EventEmitter<any>

get

  • get(url: string, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • Optional options: RequestOptionsArgs

    Returns Observable<Response> | EventEmitter<any>

head

  • head(url: string, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • Optional options: RequestOptionsArgs

    Returns Observable<Response> | EventEmitter<any>

patch

  • patch(url: string, body: string, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • body: string
    • Optional options: RequestOptionsArgs

    Returns Observable<Response> | EventEmitter<any>

post

  • post(url: string, body: string, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • body: string
    • Optional options: RequestOptionsArgs

    Returns Observable<Response> | EventEmitter<any>

preload

  • preload(url: any, factory: any): EventEmitter<Object>

  • Parameters

    • url: any
    • factory: any

    Returns EventEmitter<Object>

put

  • put(url: string, body: string, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string
    • body: string
    • Optional options: RequestOptionsArgs

    Returns Observable<Response> | EventEmitter<any>

request

  • request(url: string | Request, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

  • Parameters

    • url: string | Request
    • Optional options: RequestOptionsArgs

    Returns Observable<Response> | EventEmitter<any>

NodeXhr

NodeXhr:

constructor

  • new NodeXhr(baseUrl?: string): NodeXhr

  • Parameters

    • Optional baseUrl: string

    Returns NodeXhr

_baseUrl

_baseUrl: string

build

  • build(): XMLHttpRequest

  • Returns XMLHttpRequest

NodeXhrBackend

NodeXhrBackend:

constructor

  • new NodeXhrBackend(_browserXHR: BrowserXhr, _baseResponseOptions: ResponseOptions): NodeXhrBackend

  • Parameters

    • _browserXHR: BrowserXhr
    • _baseResponseOptions: ResponseOptions

    Returns NodeXhrBackend

_baseResponseOptions

_baseResponseOptions: ResponseOptions

_browserXHR

_browserXHR: BrowserXhr

createConnection

  • createConnection(request: any): Connection

  • Parameters

    • request: any

    Returns Connection

NodeXhrConnection

NodeXhrConnection:

constructor

  • new NodeXhrConnection(req: Request, browserXHR: BrowserXhr, baseResponseOptions?: ResponseOptions): NodeXhrConnection

  • Parameters

    • req: Request
    • browserXHR: BrowserXhr
    • Optional baseResponseOptions: ResponseOptions

    Returns NodeXhrConnection

readyState

readyState: ReadyState

request

request: Request

response

response: any

Response {@link EventEmitter} which emits a single {@link Response} value on load event of XMLHttpRequest.

CONST_EXPR

  • CONST_EXPR(v: any): any

  • Parameters

    • v: any

    Returns any

buildBaseUrl

  • buildBaseUrl(url: string, existing?: boolean): any

  • Parameters

    • url: string
    • Optional existing: boolean

    Returns any

"node_modules/angular2-universal/src/node/index"

"node_modules/angular2-universal/src/node/index":

"node_modules/angular2-universal/src/node/mock/window"

"node_modules/angular2-universal/src/node/mock/window":

methods

methods: Array<string>

readonlyAttributes

readonlyAttributes: Array<string>

replaceableAttributes

replaceableAttributes: Array<any>

unforgeableAttributes

unforgeableAttributes: Array<string>

writableAttributes

writableAttributes: Array<string>

beDefensive

  • beDefensive(win: any, prop: any): any

  • Warn the developer about direct access to Window props

    Parameters

    • win: any
    • prop: any

      The property being accessed

    Returns any

createWindow

  • createWindow(fn?: Function): any

  • Parameters

    • Default value fn: Function = beDefensive

    Returns any

setGlobal

  • setGlobal(win?: any): void

  • Parameters

    • Default value win: any = createWindow()

    Returns void

"node_modules/angular2-universal/src/node/ng_preboot"

"node_modules/angular2-universal/src/node/ng_preboot":

preboot

preboot: "/Users/gctang/js/universal/modules/hapi-engine/node_modules/preboot/dist/src/node/preboot_node"

createPrebootCode

  • createPrebootCode(componentType: any | Array<any>, prebootConfig?: any): Promise<string>

  • Parameters

    • componentType: any | Array<any>
    • Default value prebootConfig: any = {}

    Returns Promise<string>

createPrebootHTML

  • createPrebootHTML(code: string, config?: any): string

  • Parameters

    • code: string
    • Optional config: any

    Returns string

getPrebootCSS

  • getPrebootCSS(min?: boolean): string

  • Parameters

    • Optional min: boolean

    Returns string

prebootConfigDefault

  • prebootConfigDefault(config?: object): any

  • Parameters

    • Default value config: object = {}

    Returns any

"node_modules/angular2-universal/src/node/node"

"node_modules/angular2-universal/src/node/node":

"node_modules/angular2-universal/src/node/pipes/index"

"node_modules/angular2-universal/src/node/pipes/index":

NODE_PIPES

NODE_PIPES: Array<any>

NODE_PLATFORM_PIPES

NODE_PLATFORM_PIPES: Array<Provider>

"node_modules/angular2-universal/src/node/pipes/node-async-pipe"

"node_modules/angular2-universal/src/node/pipes/node-async-pipe":

NodeAsyncPipe

NodeAsyncPipe:

constructor

  • Parameters

    • _ref: ChangeDetectorRef

    Returns NodeAsyncPipe

_latestReturnedValue

_latestReturnedValue: Object
internal

_latestValue

_latestValue: Object
internal

_obj

_obj: Observable<any> | Promise<any> | EventEmitter<any>
internal

_ref

_ref: ChangeDetectorRef

_subscription

_subscription: Object
internal

_dispose

  • _dispose(): void
  • internal

    Returns void

_selectStrategy

  • _selectStrategy(obj: Observable<any> | Promise<any> | EventEmitter<any>): any
  • internal

    Parameters

    • obj: Observable<any> | Promise<any> | EventEmitter<any>

    Returns any

_subscribe

  • _subscribe(obj: Observable<any> | Promise<any> | EventEmitter<any>): void
  • internal

    Parameters

    • obj: Observable<any> | Promise<any> | EventEmitter<any>

    Returns void

_updateLatestValue

  • _updateLatestValue(async: any, value: Object): void
  • internal

    Parameters

    • async: any
    • value: Object

    Returns void

ngOnDestroy

  • ngOnDestroy(): void

  • Returns void

transform

  • transform(obj: Observable<any> | Promise<any> | EventEmitter<any>): any

  • Parameters

    • obj: Observable<any> | Promise<any> | EventEmitter<any>

    Returns any

"node_modules/angular2-universal/src/node/platform/document"

"node_modules/angular2-universal/src/node/platform/document":

DOM

DOM: any

parser

parser: unknown

serializer

serializer: unknown

treeAdapter

treeAdapter: unknown

isTag

  • isTag(tagName: any, node: any): boolean

  • Parameters

    • tagName: any
    • node: any

    Returns boolean

parseDocument

  • parseDocument(documentHtml: string): Object

  • Parameters

    • documentHtml: string

    Returns Object

parseFragment

  • parseFragment(el: string): Object

  • Parameters

    • el: string

    Returns Object

serializeDocument

  • serializeDocument(document: Object): string

  • Parameters

    • document: Object

    Returns string

"node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer"

"node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer":

NodeDomRenderer

NodeDomRenderer:

constructor

  • new NodeDomRenderer(_rootRenderer: DomRootRenderer | any, _componentProto: RenderComponentType): NodeDomRenderer

  • Parameters

    • _rootRenderer: DomRootRenderer | any
    • _componentProto: RenderComponentType

    Returns NodeDomRenderer

_setBooleanAttribute

  • _setBooleanAttribute(renderElement: any, propertyName: any, propertyValue: any): void

  • Parameters

    • renderElement: any
    • propertyName: any
    • propertyValue: any

    Returns void

_setCheckedAttribute

  • _setCheckedAttribute(renderElement: any, propertyName: any, propertyValue: any): void

  • Parameters

    • renderElement: any
    • propertyName: any
    • propertyValue: any

    Returns void

_setOnOffAttribute

  • _setOnOffAttribute(renderElement: any, propertyName: any, propertyValue: any): void

  • Parameters

    • renderElement: any
    • propertyName: any
    • propertyValue: any

    Returns void

animateNodeEnter

  • animateNodeEnter(node: Node): void

  • Performs animations if necessary

    Parameters

    • node: Node

    Returns void

animateNodeLeave

  • animateNodeLeave(node: Node): void

  • If animations are necessary, performs animations then removes the element; otherwise, it just removes the element.

    Parameters

    • node: Node

    Returns void

attachViewAfter

  • attachViewAfter(node: any, viewRootNodes: any[]): void

  • Parameters

    • node: any
    • viewRootNodes: any[]

    Returns void

createElement

  • createElement(parent: Element, name: string, debugInfo: RenderDebugInfo): Node

  • Parameters

    • parent: Element
    • name: string
    • debugInfo: RenderDebugInfo

    Returns Node

createTemplateAnchor

  • createTemplateAnchor(parentElement: any, debugInfo: RenderDebugInfo): any

  • Parameters

    • parentElement: any
    • debugInfo: RenderDebugInfo

    Returns any

createText

  • createText(parentElement: any, value: string, debugInfo: RenderDebugInfo): any

  • Parameters

    • parentElement: any
    • value: string
    • debugInfo: RenderDebugInfo

    Returns any

createViewRoot

  • createViewRoot(hostElement: any): any

  • Parameters

    • hostElement: any

    Returns any

destroyView

  • destroyView(hostElement: any, viewAllNodes: any[]): void

  • Parameters

    • hostElement: any
    • viewAllNodes: any[]

    Returns void

detachView

  • detachView(viewRootNodes: any[]): void

  • Parameters

    • viewRootNodes: any[]

    Returns void

invokeElementMethod

  • invokeElementMethod(renderElement: any, methodName: string, args: any[]): void

  • Parameters

    • renderElement: any
    • methodName: string
    • args: any[]

    Returns void

listen

  • listen(renderElement: any, name: string, callback: Function): Function

  • Parameters

    • renderElement: any
    • name: string
    • callback: Function

    Returns Function

listenGlobal

  • listenGlobal(target: string, name: string, callback: Function): Function

  • Parameters

    • target: string
    • name: string
    • callback: Function

    Returns Function

projectNodes

  • projectNodes(parentElement: any, nodes: any[]): void

  • Parameters

    • parentElement: any
    • nodes: any[]

    Returns void

selectRootElement

  • selectRootElement(selectorOrNode: string | any, debugInfo: RenderDebugInfo): Element

  • Parameters

    • selectorOrNode: string | any
    • debugInfo: RenderDebugInfo

    Returns Element

setBindingDebugInfo

  • setBindingDebugInfo(renderElement: any, propertyName: string, propertyValue: string): void

  • Parameters

    • renderElement: any
    • propertyName: string
    • propertyValue: string

    Returns void

setElementAttribute

  • setElementAttribute(renderElement: any, attributeName: string, attributeValue: string): void

  • Parameters

    • renderElement: any
    • attributeName: string
    • attributeValue: string

    Returns void

setElementClass

  • setElementClass(renderElement: any, className: string, isAdd: boolean): void

  • Parameters

    • renderElement: any
    • className: string
    • isAdd: boolean

    Returns void

setElementProperty

  • setElementProperty(renderElement: any, propertyName: string, propertyValue: any): void

  • Parameters

    • renderElement: any
    • propertyName: string
    • propertyValue: any

    Returns void

setElementStyle

  • setElementStyle(renderElement: any, styleName: string, styleValue: string): void

  • Parameters

    • renderElement: any
    • styleName: string
    • styleValue: string

    Returns void

setText

  • setText(renderNode: any, text: string): void

  • Parameters

    • renderNode: any
    • text: string

    Returns void

NodeDomRootRenderer_

NodeDomRootRenderer_:

constructor

  • new NodeDomRootRenderer_(_document: any, _eventManager: EventManager, sharedStylesHost: DomSharedStylesHost, animate: AnimationBuilder): NodeDomRootRenderer_

  • Parameters

    • _document: any
    • _eventManager: EventManager
    • sharedStylesHost: DomSharedStylesHost
    • animate: AnimationBuilder

    Returns NodeDomRootRenderer_

animate

animate: AnimationBuilder

document

document: any

eventManager

eventManager: EventManager

sharedStylesHost

sharedStylesHost: DomSharedStylesHost

renderComponent

  • renderComponent(componentProto: RenderComponentType): Renderer

  • Parameters

    • componentProto: RenderComponentType

    Returns Renderer

DOM

DOM: any

ATTRIBUTES

ATTRIBUTES: object

a

a: Array<string>

button

button: Array<string>

fieldset

fieldset: Array<string>

form

form: Array<string>

img

img: Array<string>

input

input: Array<string>

label

label: Array<string>

optgroup

optgroup: Array<string>

option

option: Array<string>

output

output: Array<string>

progress

progress: Array<string>

script

script: Array<string>

select

select: Array<string>

textarea

textarea: Array<string>

"node_modules/angular2-universal/src/node/platform/index"

"node_modules/angular2-universal/src/node/platform/index":

"node_modules/angular2-universal/src/node/platform/node"

"node_modules/angular2-universal/src/node/platform/node":

DOM

DOM: any

NODE_APP_COMMON_PROVIDERS

NODE_APP_COMMON_PROVIDERS: Array<any>

NODE_APP_PLATFORM

NODE_APP_PLATFORM: Array<any>

NODE_APP_PLATFORM_MARKER

NODE_APP_PLATFORM_MARKER: OpaqueToken

NODE_APP_PROVIDERS

NODE_APP_PROVIDERS: Array<any>

isRc0

isRc0: boolean

templateParser

templateParser: NodeTemplateParserRc0 | NodeTemplateParser

An array of providers that should be passed into application() when bootstrapping a component.

CONST_EXPR

  • CONST_EXPR(v: any): any

  • Parameters

    • v: any

    Returns any

_document

  • _document(): any

  • Returns any

_exceptionHandler

  • _exceptionHandler(): ExceptionHandler

  • Returns ExceptionHandler

bootstrap

  • bootstrap(appComponentType: Type, customAppProviders?: Array<any>, customComponentProviders?: Array<any>): Promise<ComponentRef<any>>

  • Parameters

    • appComponentType: Type
    • Default value customAppProviders: Array<any> = null
    • Default value customComponentProviders: Array<any> = null

    Returns Promise<ComponentRef<any>>

buildNodeAppProviders

  • buildNodeAppProviders(document?: any, providers?: Array<any>): Array<any>

  • Parameters

    • Optional document: any
    • Optional providers: Array<any>

    Returns Array<any>

buildNodePlatformProviders

  • buildNodePlatformProviders(appComponentType: Type, providers?: Array<any>): Array<any>

  • Parameters

    • appComponentType: Type
    • Optional providers: Array<any>

    Returns Array<any>

buildNodeProviders

  • buildNodeProviders(providers?: Array<any>): Array<any>

  • Parameters

    • Optional providers: Array<any>

    Returns Array<any>

buildReflector

  • buildReflector(): void

  • Returns void

initNodeAdapter

  • initNodeAdapter(): void

  • Returns void

"node_modules/angular2-universal/src/node/platform/node_shared_styles_host"

"node_modules/angular2-universal/src/node/platform/node_shared_styles_host":

NodeSharedStylesHost

NodeSharedStylesHost:

constructor

  • Returns NodeSharedStylesHost

_hostNodes

_hostNodes: Set<Node>

_styles

_styles: string[]
internal

_stylesSet

_stylesSet: Set<string>
internal

_addStylesToHost

  • _addStylesToHost(styles: string[], host: Node): void
  • internal

    Parameters

    • styles: string[]
    • host: Node

    Returns void

addHost

  • addHost(hostNode: Node): void

  • Parameters

    • hostNode: Node

    Returns void

addStyles

  • addStyles(styles: string[]): void

  • Parameters

    • styles: string[]

    Returns void

getAllStyles

  • getAllStyles(): string[]

  • Returns string[]

onStylesAdded

  • onStylesAdded(additions: string[]): void

  • Parameters

    • additions: string[]

    Returns void

removeHost

  • removeHost(hostNode: Node): void

  • Parameters

    • hostNode: Node

    Returns void

DOM

DOM: any

"node_modules/angular2-universal/src/node/platform/node_template_parser"

"node_modules/angular2-universal/src/node/platform/node_template_parser":

BoundElementOrDirectiveProperty

BoundElementOrDirectiveProperty:

constructor

  • Parameters

    • name: string
    • expression: AST
    • isLiteral: boolean
    • sourceSpan: ParseSourceSpan

    Returns BoundElementOrDirectiveProperty

expression

expression: AST

isLiteral

isLiteral: boolean

name

name: string

sourceSpan

sourceSpan: ParseSourceSpan

ElementContext

ElementContext:

constructor

  • new ElementContext(isTemplateElement: boolean, _ngContentIndexMatcher: SelectorMatcher, _wildcardNgContentIndex: number, providerContext: ProviderElementContext): ElementContext

  • Parameters

    • isTemplateElement: boolean
    • _ngContentIndexMatcher: SelectorMatcher
    • _wildcardNgContentIndex: number
    • providerContext: ProviderElementContext

    Returns ElementContext

_ngContentIndexMatcher

_ngContentIndexMatcher: SelectorMatcher

_wildcardNgContentIndex

_wildcardNgContentIndex: number

isTemplateElement

isTemplateElement: boolean

providerContext

providerContext: ProviderElementContext

findNgContentIndex

  • findNgContentIndex(selector: CssSelector): number

  • Parameters

    • selector: CssSelector

    Returns number

create

  • create(isTemplateElement: boolean, directives: DirectiveAst[], providerContext: ProviderElementContext): ElementContext

  • Parameters

    • isTemplateElement: boolean
    • directives: DirectiveAst[]
    • providerContext: ProviderElementContext

    Returns ElementContext

ElementOrDirectiveRef

ElementOrDirectiveRef:

constructor

  • new ElementOrDirectiveRef(name: string, value: string, sourceSpan: ParseSourceSpan): ElementOrDirectiveRef

  • Parameters

    • name: string
    • value: string
    • sourceSpan: ParseSourceSpan

    Returns ElementOrDirectiveRef

name

name: string

sourceSpan

sourceSpan: ParseSourceSpan

value

value: string

NodeTemplateParser

NodeTemplateParser:

constructor

  • new NodeTemplateParser(_exprParser: Parser, _schemaRegistry: ElementSchemaRegistry, _htmlParser: HtmlParser, _console: Console, transforms: TemplateAstVisitor[]): NodeTemplateParser

  • Parameters

    • _exprParser: Parser
    • _schemaRegistry: ElementSchemaRegistry
    • _htmlParser: HtmlParser
    • _console: Console
    • transforms: TemplateAstVisitor[]

    Returns NodeTemplateParser

_console

_console: Console

_exprParser

_exprParser: Parser

_htmlParser

_htmlParser: HtmlParser

_schemaRegistry

_schemaRegistry: ElementSchemaRegistry

transforms

transforms: TemplateAstVisitor[]

parse

  • parse(component: CompileDirectiveMetadata, template: string, directives: CompileDirectiveMetadata[], pipes: CompilePipeMetadata[], templateUrl: string): TemplateAst[]

  • Parameters

    • component: CompileDirectiveMetadata
    • template: string
    • directives: CompileDirectiveMetadata[]
    • pipes: CompilePipeMetadata[]
    • templateUrl: string

    Returns TemplateAst[]

tryParse

  • tryParse(component: CompileDirectiveMetadata, template: string, directives: CompileDirectiveMetadata[], pipes: CompilePipeMetadata[], templateUrl: string): TemplateParseResult

  • Parameters

    • component: CompileDirectiveMetadata
    • template: string
    • directives: CompileDirectiveMetadata[]
    • pipes: CompilePipeMetadata[]
    • templateUrl: string

    Returns TemplateParseResult

NonBindableVisitor

NonBindableVisitor:

visitAttr

  • visitAttr(ast: HtmlAttrAst, context: any): AttrAst

  • Parameters

    • ast: HtmlAttrAst
    • context: any

    Returns AttrAst

visitComment

  • visitComment(ast: HtmlCommentAst, context: any): any

  • Parameters

    • ast: HtmlCommentAst
    • context: any

    Returns any

visitElement

  • visitElement(ast: HtmlElementAst, parent: ElementContext): ElementAst

  • Parameters

    Returns ElementAst

visitExpansion

  • visitExpansion(ast: HtmlExpansionAst, context: any): any

  • Parameters

    • ast: HtmlExpansionAst
    • context: any

    Returns any

visitExpansionCase

  • visitExpansionCase(ast: HtmlExpansionCaseAst, context: any): any

  • Parameters

    • ast: HtmlExpansionCaseAst
    • context: any

    Returns any

visitText

  • Parameters

    Returns TextAst

PipeCollector

PipeCollector:

pipes

pipes: Set<string>

visitAll

  • visitAll(asts: AST[], context: any): any

  • Parameters

    • asts: AST[]
    • context: any

    Returns any

visitBinary

  • visitBinary(ast: Binary, context: any): any

  • Parameters

    • ast: Binary
    • context: any

    Returns any

visitChain

  • visitChain(ast: Chain, context: any): any

  • Parameters

    • ast: Chain
    • context: any

    Returns any

visitConditional

  • visitConditional(ast: Conditional, context: any): any

  • Parameters

    • ast: Conditional
    • context: any

    Returns any

visitFunctionCall

  • visitFunctionCall(ast: FunctionCall, context: any): any

  • Parameters

    • ast: FunctionCall
    • context: any

    Returns any

visitImplicitReceiver

  • visitImplicitReceiver(ast: ImplicitReceiver, context: any): any

  • Parameters

    • ast: ImplicitReceiver
    • context: any

    Returns any

visitInterpolation

  • visitInterpolation(ast: Interpolation, context: any): any

  • Parameters

    • ast: Interpolation
    • context: any

    Returns any

visitKeyedRead

  • visitKeyedRead(ast: KeyedRead, context: any): any

  • Parameters

    • ast: KeyedRead
    • context: any

    Returns any

visitKeyedWrite

  • visitKeyedWrite(ast: KeyedWrite, context: any): any

  • Parameters

    • ast: KeyedWrite
    • context: any

    Returns any

visitLiteralArray

  • visitLiteralArray(ast: LiteralArray, context: any): any

  • Parameters

    • ast: LiteralArray
    • context: any

    Returns any

visitLiteralMap

  • visitLiteralMap(ast: LiteralMap, context: any): any

  • Parameters

    • ast: LiteralMap
    • context: any

    Returns any

visitLiteralPrimitive

  • visitLiteralPrimitive(ast: LiteralPrimitive, context: any): any

  • Parameters

    • ast: LiteralPrimitive
    • context: any

    Returns any

visitMethodCall

  • visitMethodCall(ast: MethodCall, context: any): any

  • Parameters

    • ast: MethodCall
    • context: any

    Returns any

visitPipe

  • visitPipe(ast: BindingPipe, context: any): any

  • Parameters

    • ast: BindingPipe
    • context: any

    Returns any

visitPrefixNot

  • visitPrefixNot(ast: PrefixNot, context: any): any

  • Parameters

    • ast: PrefixNot
    • context: any

    Returns any

visitPropertyRead

  • visitPropertyRead(ast: PropertyRead, context: any): any

  • Parameters

    • ast: PropertyRead
    • context: any

    Returns any

visitPropertyWrite

  • visitPropertyWrite(ast: PropertyWrite, context: any): any

  • Parameters

    • ast: PropertyWrite
    • context: any

    Returns any

visitQuote

  • visitQuote(ast: Quote, context: any): any

  • Parameters

    • ast: Quote
    • context: any

    Returns any

visitSafeMethodCall

  • visitSafeMethodCall(ast: SafeMethodCall, context: any): any

  • Parameters

    • ast: SafeMethodCall
    • context: any

    Returns any

visitSafePropertyRead

  • visitSafePropertyRead(ast: SafePropertyRead, context: any): any

  • Parameters

    • ast: SafePropertyRead
    • context: any

    Returns any

TemplateParseVisitor

TemplateParseVisitor:

constructor

  • new TemplateParseVisitor(providerViewContext: ProviderViewContext, directives: CompileDirectiveMetadata[], pipes: CompilePipeMetadata[], _exprParser: Parser, _schemaRegistry: ElementSchemaRegistry): TemplateParseVisitor

  • Parameters

    • providerViewContext: ProviderViewContext
    • directives: CompileDirectiveMetadata[]
    • pipes: CompilePipeMetadata[]
    • _exprParser: Parser
    • _schemaRegistry: ElementSchemaRegistry

    Returns TemplateParseVisitor

_exprParser

_exprParser: Parser

_schemaRegistry

_schemaRegistry: ElementSchemaRegistry

directivesIndex

directivesIndex: Map<CompileDirectiveMetadata, number>

errors

errors: TemplateParseError[]

ngContentCount

ngContentCount: number

pipesByName

pipesByName: Map<string, CompilePipeMetadata>

providerViewContext

providerViewContext: ProviderViewContext

selectorMatcher

selectorMatcher: SelectorMatcher

_assertAllEventsPublishedByDirectives

  • _assertAllEventsPublishedByDirectives(directives: DirectiveAst[], events: BoundEventAst[]): void

  • Parameters

    • directives: DirectiveAst[]
    • events: BoundEventAst[]

    Returns void

_assertNoComponentsNorElementBindingsOnTemplate

  • _assertNoComponentsNorElementBindingsOnTemplate(directives: DirectiveAst[], elementProps: BoundElementPropertyAst[], sourceSpan: ParseSourceSpan): void

  • Parameters

    • directives: DirectiveAst[]
    • elementProps: BoundElementPropertyAst[]
    • sourceSpan: ParseSourceSpan

    Returns void

_assertOnlyOneComponent

  • _assertOnlyOneComponent(directives: DirectiveAst[], sourceSpan: ParseSourceSpan): void

  • Parameters

    • directives: DirectiveAst[]
    • sourceSpan: ParseSourceSpan

    Returns void

_checkPipes

  • _checkPipes(ast: ASTWithSource, sourceSpan: ParseSourceSpan): void

  • Parameters

    • ast: ASTWithSource
    • sourceSpan: ParseSourceSpan

    Returns void

_createDirectiveAsts

  • _createDirectiveAsts(isTemplateElement: boolean, elementName: string, directives: CompileDirectiveMetadata[], props: BoundElementOrDirectiveProperty[], elementOrDirectiveRefs: ElementOrDirectiveRef[], sourceSpan: ParseSourceSpan, targetReferences: ReferenceAst[]): DirectiveAst[]

  • Parameters

    Returns DirectiveAst[]

_createDirectiveHostEventAsts

  • _createDirectiveHostEventAsts(hostListeners: object, sourceSpan: ParseSourceSpan, targetEventAsts: BoundEventAst[]): void

  • Parameters

    • hostListeners: object
      • [key: string]: string
    • sourceSpan: ParseSourceSpan
    • targetEventAsts: BoundEventAst[]

    Returns void

_createDirectiveHostPropertyAsts

  • _createDirectiveHostPropertyAsts(elementName: string, hostProps: object, sourceSpan: ParseSourceSpan, targetPropertyAsts: BoundElementPropertyAst[]): void

  • Parameters

    • elementName: string
    • hostProps: object
      • [key: string]: string
    • sourceSpan: ParseSourceSpan
    • targetPropertyAsts: BoundElementPropertyAst[]

    Returns void

_createDirectivePropertyAsts

  • _createDirectivePropertyAsts(directiveProperties: object, boundProps: BoundElementOrDirectiveProperty[], targetBoundDirectiveProps: BoundDirectivePropertyAst[]): void

  • Parameters

    Returns void

_createElementPropertyAst

  • _createElementPropertyAst(elementName: string, name: string, ast: AST, sourceSpan: ParseSourceSpan): BoundElementPropertyAst

  • Parameters

    • elementName: string
    • name: string
    • ast: AST
    • sourceSpan: ParseSourceSpan

    Returns BoundElementPropertyAst

_createElementPropertyAsts

  • Parameters

    Returns BoundElementPropertyAst[]

_findComponentDirectiveNames

  • _findComponentDirectiveNames(directives: DirectiveAst[]): string[]

  • Parameters

    • directives: DirectiveAst[]

    Returns string[]

_normalizeAttributeName

  • _normalizeAttributeName(attrName: string): string

  • Parameters

    • attrName: string

    Returns string

_parseAction

  • _parseAction(value: string, sourceSpan: ParseSourceSpan): ASTWithSource

  • Parameters

    • value: string
    • sourceSpan: ParseSourceSpan

    Returns ASTWithSource

_parseAssignmentEvent

  • _parseAssignmentEvent(name: string, expression: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetEvents: BoundEventAst[]): void

  • Parameters

    • name: string
    • expression: string
    • sourceSpan: ParseSourceSpan
    • targetMatchableAttrs: string[]
    • targetEvents: BoundEventAst[]

    Returns void

_parseAttr

  • Parameters

    Returns boolean

_parseBinding

  • _parseBinding(value: string, sourceSpan: ParseSourceSpan): ASTWithSource

  • Parameters

    • value: string
    • sourceSpan: ParseSourceSpan

    Returns ASTWithSource

_parseDirectives

  • _parseDirectives(selectorMatcher: SelectorMatcher, elementCssSelector: CssSelector): CompileDirectiveMetadata[]

  • Parameters

    • selectorMatcher: SelectorMatcher
    • elementCssSelector: CssSelector

    Returns CompileDirectiveMetadata[]

_parseEvent

  • _parseEvent(name: string, expression: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetEvents: BoundEventAst[]): void

  • Parameters

    • name: string
    • expression: string
    • sourceSpan: ParseSourceSpan
    • targetMatchableAttrs: string[]
    • targetEvents: BoundEventAst[]

    Returns void

_parseInlineTemplateBinding

  • _parseInlineTemplateBinding(attr: HtmlAttrAst, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[], targetVars: VariableAst[]): boolean

  • Parameters

    Returns boolean

_parseInterpolation

  • _parseInterpolation(value: string, sourceSpan: ParseSourceSpan): ASTWithSource

  • Parameters

    • value: string
    • sourceSpan: ParseSourceSpan

    Returns ASTWithSource

_parseLiteralAttr

  • Parameters

    Returns void

_parseProperty

  • _parseProperty(name: string, expression: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[]): void

  • Parameters

    Returns void

_parsePropertyAst

  • _parsePropertyAst(name: string, ast: ASTWithSource, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[]): void

  • Parameters

    Returns void

_parsePropertyInterpolation

  • _parsePropertyInterpolation(name: string, value: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[]): boolean

  • Parameters

    Returns boolean

_parseReference

  • _parseReference(identifier: string, value: string, sourceSpan: ParseSourceSpan, targetRefs: ElementOrDirectiveRef[]): void

  • Parameters

    Returns void

_parseTemplateBindings

  • _parseTemplateBindings(value: string, sourceSpan: ParseSourceSpan): TemplateBinding[]

  • Parameters

    • value: string
    • sourceSpan: ParseSourceSpan

    Returns TemplateBinding[]

_parseVariable

  • _parseVariable(identifier: string, value: string, sourceSpan: ParseSourceSpan, targetVars: VariableAst[]): void

  • Parameters

    • identifier: string
    • value: string
    • sourceSpan: ParseSourceSpan
    • targetVars: VariableAst[]

    Returns void

_reportError

  • _reportError(message: string, sourceSpan: ParseSourceSpan, level?: ParseErrorLevel): void

  • Parameters

    • message: string
    • sourceSpan: ParseSourceSpan
    • Default value level: ParseErrorLevel = ParseErrorLevel.FATAL

    Returns void

visitAttr

  • visitAttr(ast: HtmlAttrAst, contex: any): any

  • Parameters

    • ast: HtmlAttrAst
    • contex: any

    Returns any

visitComment

  • visitComment(ast: HtmlCommentAst, context: any): any

  • Parameters

    • ast: HtmlCommentAst
    • context: any

    Returns any

visitElement

  • Parameters

    Returns any

visitExpansion

  • visitExpansion(ast: HtmlExpansionAst, context: any): any

  • Parameters

    • ast: HtmlExpansionAst
    • context: any

    Returns any

visitExpansionCase

  • visitExpansionCase(ast: HtmlExpansionCaseAst, context: any): any

  • Parameters

    • ast: HtmlExpansionCaseAst
    • context: any

    Returns any

visitText

  • Parameters

    Returns any

ATTRIBUTE_PREFIX

ATTRIBUTE_PREFIX: string

BIND_NAME_REGEXP

BIND_NAME_REGEXP: RegExp

CLASS_ATTR

CLASS_ATTR: string

CLASS_PREFIX

CLASS_PREFIX: string

Console

Console: Console

EMPTY_ELEMENT_CONTEXT

EMPTY_ELEMENT_CONTEXT: ElementContext

MAX_INTERPOLATION_VALUES

MAX_INTERPOLATION_VALUES: number

NON_BINDABLE_VISITOR

NON_BINDABLE_VISITOR: NonBindableVisitor

PROPERTY_PARTS_SEPARATOR

PROPERTY_PARTS_SEPARATOR: string

STYLE_PREFIX

STYLE_PREFIX: string

SecurityContext

SecurityContext: SecurityContext

TEMPLATE_ATTR

TEMPLATE_ATTR: string

TEMPLATE_ATTR_PREFIX

TEMPLATE_ATTR_PREFIX: string

TEMPLATE_ELEMENT

TEMPLATE_ELEMENT: string

TEXT_CSS_SELECTOR

TEXT_CSS_SELECTOR: CssSelector

createElementCssSelector

  • createElementCssSelector(elementName: string, matchableAttrs: string[]): CssSelector

  • Parameters

    • elementName: string
    • matchableAttrs: string[]

    Returns CssSelector

removeDuplicates

  • removeDuplicates(items: CompileMetadataWithType[]): CompileMetadataWithType[]

  • Parameters

    • items: CompileMetadataWithType[]

    Returns CompileMetadataWithType[]

splitClasses

  • splitClasses(classAttrValue: string): string[]

  • Parameters

    • classAttrValue: string

    Returns string[]

"node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0"

"node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0":

BoundElementOrDirectiveProperty

BoundElementOrDirectiveProperty:

constructor

  • Parameters

    • name: string
    • expression: AST
    • isLiteral: boolean
    • sourceSpan: ParseSourceSpan

    Returns BoundElementOrDirectiveProperty

expression

expression: AST

isLiteral

isLiteral: boolean

name

name: string

sourceSpan

sourceSpan: ParseSourceSpan

ElementContext

ElementContext:

constructor

  • new ElementContext(isTemplateElement: boolean, _ngContentIndexMatcher: SelectorMatcher, _wildcardNgContentIndex: number, providerContext: ProviderElementContext): ElementContext

  • Parameters

    • isTemplateElement: boolean
    • _ngContentIndexMatcher: SelectorMatcher
    • _wildcardNgContentIndex: number
    • providerContext: ProviderElementContext

    Returns ElementContext

_ngContentIndexMatcher

_ngContentIndexMatcher: SelectorMatcher

_wildcardNgContentIndex

_wildcardNgContentIndex: number

isTemplateElement

isTemplateElement: boolean

providerContext

providerContext: ProviderElementContext

findNgContentIndex

  • findNgContentIndex(selector: CssSelector): number

  • Parameters

    • selector: CssSelector

    Returns number

create

  • create(isTemplateElement: boolean, directives: DirectiveAst[], providerContext: ProviderElementContext): ElementContext

  • Parameters

    • isTemplateElement: boolean
    • directives: DirectiveAst[]
    • providerContext: ProviderElementContext

    Returns ElementContext

ElementOrDirectiveRef

ElementOrDirectiveRef:

constructor

  • new ElementOrDirectiveRef(name: string, value: string, sourceSpan: ParseSourceSpan): ElementOrDirectiveRef

  • Parameters

    • name: string
    • value: string
    • sourceSpan: ParseSourceSpan

    Returns ElementOrDirectiveRef

name

name: string

sourceSpan

sourceSpan: ParseSourceSpan

value

value: string

NodeTemplateParserRc0

NodeTemplateParserRc0:

constructor

  • new NodeTemplateParserRc0(_exprParser: Parser, _schemaRegistry: ElementSchemaRegistry, _htmlParser: HtmlParser, _console: Console, transforms: TemplateAstVisitor[]): NodeTemplateParserRc0

  • Parameters

    • _exprParser: Parser
    • _schemaRegistry: ElementSchemaRegistry
    • _htmlParser: HtmlParser
    • _console: Console
    • transforms: TemplateAstVisitor[]

    Returns NodeTemplateParserRc0

_console

_console: Console

_exprParser

_exprParser: Parser

_htmlParser

_htmlParser: HtmlParser

_schemaRegistry

_schemaRegistry: ElementSchemaRegistry

transforms

transforms: TemplateAstVisitor[]

parse

  • parse(component: CompileDirectiveMetadata, template: string, directives: CompileDirectiveMetadata[], pipes: CompilePipeMetadata[], templateUrl: string): TemplateAst[]

  • Parameters

    • component: CompileDirectiveMetadata
    • template: string
    • directives: CompileDirectiveMetadata[]
    • pipes: CompilePipeMetadata[]
    • templateUrl: string

    Returns TemplateAst[]

tryParse

  • tryParse(component: CompileDirectiveMetadata, template: string, directives: CompileDirectiveMetadata[], pipes: CompilePipeMetadata[], templateUrl: string): TemplateParseResult

  • Parameters

    • component: CompileDirectiveMetadata
    • template: string
    • directives: CompileDirectiveMetadata[]
    • pipes: CompilePipeMetadata[]
    • templateUrl: string

    Returns TemplateParseResult

NonBindableVisitor

NonBindableVisitor:

visitAttr

  • visitAttr(ast: HtmlAttrAst, context: any): AttrAst

  • Parameters

    • ast: HtmlAttrAst
    • context: any

    Returns AttrAst

visitComment

  • visitComment(ast: HtmlCommentAst, context: any): any

  • Parameters

    • ast: HtmlCommentAst
    • context: any

    Returns any

visitElement

  • visitElement(ast: HtmlElementAst, parent: ElementContext): ElementAst

  • Parameters

    Returns ElementAst

visitExpansion

  • visitExpansion(ast: HtmlExpansionAst, context: any): any

  • Parameters

    • ast: HtmlExpansionAst
    • context: any

    Returns any

visitExpansionCase

  • visitExpansionCase(ast: HtmlExpansionCaseAst, context: any): any

  • Parameters

    • ast: HtmlExpansionCaseAst
    • context: any

    Returns any

visitText

  • Parameters

    Returns TextAst

PipeCollector

PipeCollector:

pipes

pipes: Set<string>

visitAll

  • visitAll(asts: AST[], context: any): any

  • Parameters

    • asts: AST[]
    • context: any

    Returns any

visitBinary

  • visitBinary(ast: Binary, context: any): any

  • Parameters

    • ast: Binary
    • context: any

    Returns any

visitChain

  • visitChain(ast: Chain, context: any): any

  • Parameters

    • ast: Chain
    • context: any

    Returns any

visitConditional

  • visitConditional(ast: Conditional, context: any): any

  • Parameters

    • ast: Conditional
    • context: any

    Returns any

visitFunctionCall

  • visitFunctionCall(ast: FunctionCall, context: any): any

  • Parameters

    • ast: FunctionCall
    • context: any

    Returns any

visitImplicitReceiver

  • visitImplicitReceiver(ast: ImplicitReceiver, context: any): any

  • Parameters

    • ast: ImplicitReceiver
    • context: any

    Returns any

visitInterpolation

  • visitInterpolation(ast: Interpolation, context: any): any

  • Parameters

    • ast: Interpolation
    • context: any

    Returns any

visitKeyedRead

  • visitKeyedRead(ast: KeyedRead, context: any): any

  • Parameters

    • ast: KeyedRead
    • context: any

    Returns any

visitKeyedWrite

  • visitKeyedWrite(ast: KeyedWrite, context: any): any

  • Parameters

    • ast: KeyedWrite
    • context: any

    Returns any

visitLiteralArray

  • visitLiteralArray(ast: LiteralArray, context: any): any

  • Parameters

    • ast: LiteralArray
    • context: any

    Returns any

visitLiteralMap

  • visitLiteralMap(ast: LiteralMap, context: any): any

  • Parameters

    • ast: LiteralMap
    • context: any

    Returns any

visitLiteralPrimitive

  • visitLiteralPrimitive(ast: LiteralPrimitive, context: any): any

  • Parameters

    • ast: LiteralPrimitive
    • context: any

    Returns any

visitMethodCall

  • visitMethodCall(ast: MethodCall, context: any): any

  • Parameters

    • ast: MethodCall
    • context: any

    Returns any

visitPipe

  • visitPipe(ast: BindingPipe, context: any): any

  • Parameters

    • ast: BindingPipe
    • context: any

    Returns any

visitPrefixNot

  • visitPrefixNot(ast: PrefixNot, context: any): any

  • Parameters

    • ast: PrefixNot
    • context: any

    Returns any

visitPropertyRead

  • visitPropertyRead(ast: PropertyRead, context: any): any

  • Parameters

    • ast: PropertyRead
    • context: any

    Returns any

visitPropertyWrite

  • visitPropertyWrite(ast: PropertyWrite, context: any): any

  • Parameters

    • ast: PropertyWrite
    • context: any

    Returns any

visitQuote

  • visitQuote(ast: Quote, context: any): any

  • Parameters

    • ast: Quote
    • context: any

    Returns any

visitSafeMethodCall

  • visitSafeMethodCall(ast: SafeMethodCall, context: any): any

  • Parameters

    • ast: SafeMethodCall
    • context: any

    Returns any

visitSafePropertyRead

  • visitSafePropertyRead(ast: SafePropertyRead, context: any): any

  • Parameters

    • ast: SafePropertyRead
    • context: any

    Returns any

TemplateParseVisitor

TemplateParseVisitor:

constructor

  • new TemplateParseVisitor(providerViewContext: ProviderViewContext, directives: CompileDirectiveMetadata[], pipes: CompilePipeMetadata[], _exprParser: Parser, _schemaRegistry: ElementSchemaRegistry): TemplateParseVisitor

  • Parameters

    • providerViewContext: ProviderViewContext
    • directives: CompileDirectiveMetadata[]
    • pipes: CompilePipeMetadata[]
    • _exprParser: Parser
    • _schemaRegistry: ElementSchemaRegistry

    Returns TemplateParseVisitor

_exprParser

_exprParser: Parser

_schemaRegistry

_schemaRegistry: ElementSchemaRegistry

directivesIndex

directivesIndex: Map<CompileDirectiveMetadata, number>

errors

errors: TemplateParseError[]

ngContentCount

ngContentCount: number

pipesByName

pipesByName: Map<string, CompilePipeMetadata>

providerViewContext

providerViewContext: ProviderViewContext

selectorMatcher

selectorMatcher: SelectorMatcher

_assertAllEventsPublishedByDirectives

  • _assertAllEventsPublishedByDirectives(directives: DirectiveAst[], events: BoundEventAst[]): void

  • Parameters

    • directives: DirectiveAst[]
    • events: BoundEventAst[]

    Returns void

_assertNoComponentsNorElementBindingsOnTemplate

  • _assertNoComponentsNorElementBindingsOnTemplate(directives: DirectiveAst[], elementProps: BoundElementPropertyAst[], sourceSpan: ParseSourceSpan): void

  • Parameters

    • directives: DirectiveAst[]
    • elementProps: BoundElementPropertyAst[]
    • sourceSpan: ParseSourceSpan

    Returns void

_assertOnlyOneComponent

  • _assertOnlyOneComponent(directives: DirectiveAst[], sourceSpan: ParseSourceSpan): void

  • Parameters

    • directives: DirectiveAst[]
    • sourceSpan: ParseSourceSpan

    Returns void

_checkPipes

  • _checkPipes(ast: ASTWithSource, sourceSpan: ParseSourceSpan): void

  • Parameters

    • ast: ASTWithSource
    • sourceSpan: ParseSourceSpan

    Returns void

_createDirectiveAsts

  • _createDirectiveAsts(isTemplateElement: boolean, elementName: string, directives: CompileDirectiveMetadata[], props: BoundElementOrDirectiveProperty[], elementOrDirectiveRefs: ElementOrDirectiveRef[], sourceSpan: ParseSourceSpan, targetReferences: ReferenceAst[]): DirectiveAst[]

  • Parameters

    Returns DirectiveAst[]

_createDirectiveHostEventAsts

  • _createDirectiveHostEventAsts(hostListeners: object, sourceSpan: ParseSourceSpan, targetEventAsts: BoundEventAst[]): void

  • Parameters

    • hostListeners: object
      • [key: string]: string
    • sourceSpan: ParseSourceSpan
    • targetEventAsts: BoundEventAst[]

    Returns void

_createDirectiveHostPropertyAsts

  • _createDirectiveHostPropertyAsts(elementName: string, hostProps: object, sourceSpan: ParseSourceSpan, targetPropertyAsts: BoundElementPropertyAst[]): void

  • Parameters

    • elementName: string
    • hostProps: object
      • [key: string]: string
    • sourceSpan: ParseSourceSpan
    • targetPropertyAsts: BoundElementPropertyAst[]

    Returns void

_createDirectivePropertyAsts

  • _createDirectivePropertyAsts(directiveProperties: object, boundProps: BoundElementOrDirectiveProperty[], targetBoundDirectiveProps: BoundDirectivePropertyAst[]): void

  • Parameters

    Returns void

_createElementPropertyAst

  • _createElementPropertyAst(elementName: string, name: string, ast: AST, sourceSpan: ParseSourceSpan): BoundElementPropertyAst

  • Parameters

    • elementName: string
    • name: string
    • ast: AST
    • sourceSpan: ParseSourceSpan

    Returns BoundElementPropertyAst

_createElementPropertyAsts

  • Parameters

    Returns BoundElementPropertyAst[]

_findComponentDirectiveNames

  • _findComponentDirectiveNames(directives: DirectiveAst[]): string[]

  • Parameters

    • directives: DirectiveAst[]

    Returns string[]

_normalizeAttributeName

  • _normalizeAttributeName(attrName: string): string

  • Parameters

    • attrName: string

    Returns string

_parseAction

  • _parseAction(value: string, sourceSpan: ParseSourceSpan): ASTWithSource

  • Parameters

    • value: string
    • sourceSpan: ParseSourceSpan

    Returns ASTWithSource

_parseAssignmentEvent

  • _parseAssignmentEvent(name: string, expression: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetEvents: BoundEventAst[]): void

  • Parameters

    • name: string
    • expression: string
    • sourceSpan: ParseSourceSpan
    • targetMatchableAttrs: string[]
    • targetEvents: BoundEventAst[]

    Returns void

_parseAttr

  • Parameters

    Returns boolean

_parseBinding

  • _parseBinding(value: string, sourceSpan: ParseSourceSpan): ASTWithSource

  • Parameters

    • value: string
    • sourceSpan: ParseSourceSpan

    Returns ASTWithSource

_parseDirectives

  • _parseDirectives(selectorMatcher: SelectorMatcher, elementCssSelector: CssSelector): CompileDirectiveMetadata[]

  • Parameters

    • selectorMatcher: SelectorMatcher
    • elementCssSelector: CssSelector

    Returns CompileDirectiveMetadata[]

_parseEvent

  • _parseEvent(name: string, expression: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetEvents: BoundEventAst[]): void

  • Parameters

    • name: string
    • expression: string
    • sourceSpan: ParseSourceSpan
    • targetMatchableAttrs: string[]
    • targetEvents: BoundEventAst[]

    Returns void

_parseInlineTemplateBinding

  • _parseInlineTemplateBinding(attr: HtmlAttrAst, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[], targetVars: VariableAst[]): boolean

  • Parameters

    Returns boolean

_parseInterpolation

  • _parseInterpolation(value: string, sourceSpan: ParseSourceSpan): ASTWithSource

  • Parameters

    • value: string
    • sourceSpan: ParseSourceSpan

    Returns ASTWithSource

_parseLiteralAttr

  • Parameters

    Returns void

_parseProperty

  • _parseProperty(name: string, expression: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[]): void

  • Parameters

    Returns void

_parsePropertyAst

  • _parsePropertyAst(name: string, ast: ASTWithSource, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[]): void

  • Parameters

    Returns void

_parsePropertyInterpolation

  • _parsePropertyInterpolation(name: string, value: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[]): boolean

  • Parameters

    Returns boolean

_parseReference

  • _parseReference(identifier: string, value: string, sourceSpan: ParseSourceSpan, targetRefs: ElementOrDirectiveRef[]): void

  • Parameters

    Returns void

_parseTemplateBindings

  • _parseTemplateBindings(value: string, sourceSpan: ParseSourceSpan): TemplateBinding[]

  • Parameters

    • value: string
    • sourceSpan: ParseSourceSpan

    Returns TemplateBinding[]

_parseVariable

  • _parseVariable(identifier: string, value: string, sourceSpan: ParseSourceSpan, targetVars: VariableAst[]): void

  • Parameters

    • identifier: string
    • value: string
    • sourceSpan: ParseSourceSpan
    • targetVars: VariableAst[]

    Returns void

_reportError

  • _reportError(message: string, sourceSpan: ParseSourceSpan, level?: ParseErrorLevel): void

  • Parameters

    • message: string
    • sourceSpan: ParseSourceSpan
    • Default value level: ParseErrorLevel = ParseErrorLevel.FATAL

    Returns void

visitAttr

  • visitAttr(ast: HtmlAttrAst, contex: any): any

  • Parameters

    • ast: HtmlAttrAst
    • contex: any

    Returns any

visitComment

  • visitComment(ast: HtmlCommentAst, context: any): any

  • Parameters

    • ast: HtmlCommentAst
    • context: any

    Returns any

visitElement

  • Parameters

    Returns any

visitExpansion

  • visitExpansion(ast: HtmlExpansionAst, context: any): any

  • Parameters

    • ast: HtmlExpansionAst
    • context: any

    Returns any

visitExpansionCase

  • visitExpansionCase(ast: HtmlExpansionCaseAst, context: any): any

  • Parameters

    • ast: HtmlExpansionCaseAst
    • context: any

    Returns any

visitText

  • Parameters

    Returns any

ATTRIBUTE_PREFIX

ATTRIBUTE_PREFIX: string

BIND_NAME_REGEXP

BIND_NAME_REGEXP: RegExp

CLASS_ATTR

CLASS_ATTR: string

CLASS_PREFIX

CLASS_PREFIX: string

Console

Console: Console

EMPTY_ELEMENT_CONTEXT

EMPTY_ELEMENT_CONTEXT: ElementContext

MAX_INTERPOLATION_VALUES

MAX_INTERPOLATION_VALUES: number

NON_BINDABLE_VISITOR

NON_BINDABLE_VISITOR: NonBindableVisitor

PROPERTY_PARTS_SEPARATOR

PROPERTY_PARTS_SEPARATOR: string

STYLE_PREFIX

STYLE_PREFIX: string

SecurityContext

SecurityContext: SecurityContext

TEMPLATE_ATTR

TEMPLATE_ATTR: string

TEMPLATE_ATTR_PREFIX

TEMPLATE_ATTR_PREFIX: string

TEMPLATE_ELEMENT

TEMPLATE_ELEMENT: string

TEXT_CSS_SELECTOR

TEXT_CSS_SELECTOR: CssSelector

createElementCssSelector

  • createElementCssSelector(elementName: string, matchableAttrs: string[]): CssSelector

  • Parameters

    • elementName: string
    • matchableAttrs: string[]

    Returns CssSelector

removeDuplicates

  • removeDuplicates(items: CompileMetadataWithType[]): CompileMetadataWithType[]

  • Parameters

    • items: CompileMetadataWithType[]

    Returns CompileMetadataWithType[]

splitClasses

  • splitClasses(classAttrValue: string): string[]

  • Parameters

    • classAttrValue: string

    Returns string[]

"node_modules/angular2-universal/src/node/platform/node_xhr_impl"

"node_modules/angular2-universal/src/node/platform/node_xhr_impl":

NodeXHRImpl

NodeXHRImpl:

constructor

  • new NodeXHRImpl(ngZone: NgZone, _originUrl?: string, _baseUrl?: string): NodeXHRImpl

  • Parameters

    • ngZone: NgZone
    • Default value _originUrl: string = ""
    • Optional _baseUrl: string

    Returns NodeXHRImpl

_baseUrl

_baseUrl: string

_originUrl

_originUrl: string

ngZone

ngZone: NgZone

get

  • get(templateUrl: string): Promise<string>

  • Parameters

    • templateUrl: string

    Returns Promise<string>

"node_modules/angular2-universal/src/node/render"

"node_modules/angular2-universal/src/node/render":

appRefSyncRender

  • appRefSyncRender(appRef: any): string

  • Parameters

    • appRef: any

    Returns string

applicationToString

  • applicationToString(appRef: ComponentRef<any>): string

  • Parameters

    • appRef: ComponentRef<any>

    Returns string

renderDocument

  • renderDocument(documentHtml: string, componentType: Type, nodeProviders?: any): Promise<string>

  • Parameters

    • documentHtml: string
    • componentType: Type
    • Optional nodeProviders: any

    Returns Promise<string>

renderDocumentWithPreboot

  • renderDocumentWithPreboot(documentHtml: string, componentType: Type, nodeProviders?: any, prebootConfig?: any): Promise<string>

  • Parameters

    • documentHtml: string
    • componentType: Type
    • Optional nodeProviders: any
    • Default value prebootConfig: any = {}

    Returns Promise<string>

renderToString

  • renderToString(componentType: any, nodeProviders?: any): Promise<string>

  • Parameters

    • componentType: any
    • Optional nodeProviders: any

    Returns Promise<string>

renderToStringWithPreboot

  • renderToStringWithPreboot(componentType: any, nodeProviders?: any, prebootConfig?: any): Promise<string>

  • Parameters

    • componentType: any
    • Optional nodeProviders: any
    • Default value prebootConfig: any = {}

    Returns Promise<string>

serializeApplication

  • serializeApplication(element: any, styles: string[], cache?: any): string

  • Parameters

    • element: any
    • styles: string[]
    • Optional cache: any

    Returns string

waitRouter

  • waitRouter(appRef: ComponentRef<any>): Promise<ComponentRef<any>>

  • Parameters

    • appRef: ComponentRef<any>

    Returns Promise<ComponentRef<any>>

"node_modules/angular2-universal/src/node/router/index"

"node_modules/angular2-universal/src/node/router/index":

NODE_LOCATION_PROVIDERS

NODE_LOCATION_PROVIDERS: Array<any>

NODE_ROUTER_PROVIDERS

NODE_ROUTER_PROVIDERS: Array<any>

"node_modules/angular2-universal/src/node/router/node_platform_location"

"node_modules/angular2-universal/src/node/router/node_platform_location":

NodeLocation

NodeLocation:

constructor

  • new NodeLocation(config: NodeLocationConfig & LocationConfig): NodeLocation

  • Parameters

    • config: NodeLocationConfig & LocationConfig

    Returns NodeLocation

hash

hash: string

host

host: string

hostname

hostname: string

href

href: string

pathname

pathname: string

port

port: string

protocol

protocol: string

search

search: string

origin

origin:

assign

  • Parameters

    Returns

format

  • Parameters

    Returns string

parse

  • parse(url: string): Url

  • Parameters

    • url: string

    Returns Url

NodePlatformLocation

NodePlatformLocation:

constructor

  • new NodePlatformLocation(originUrl: string, requestUrl: string, baseUrl?: string): NodePlatformLocation

  • Parameters

    • originUrl: string
    • requestUrl: string
    • Optional baseUrl: string

    Returns NodePlatformLocation

_baseUrl

_baseUrl: string

_loc

_loc: LocationConfig

_originUrl

_originUrl: string

_popStateListeners

_popStateListeners: Array<Function>

_stack

_stack: Array<State>

_stackIndex

_stackIndex: number

hash

hash:

pathname

pathname:

search

search:

_callPopStateListeners

  • _callPopStateListeners(): void

  • Returns void

_setLocationByUrl

  • _setLocationByUrl(url: string): void

  • Parameters

    • url: string

    Returns void

_updateLocation

  • _updateLocation(): void

  • Returns void

back

  • back(): void

  • Returns void

forward

  • forward(): void

  • Returns void

getBaseHref

  • getBaseHref(): string

  • Returns string

getBaseHrefFromDOM

  • getBaseHrefFromDOM(): string

  • Returns string

onHashChange

  • onHashChange(fn: any): void

  • Parameters

    • fn: any

    Returns void

onPopState

  • onPopState(fn: any): void

  • Parameters

    • fn: any

    Returns void

path

  • path(): string

  • Returns string

prepareExternalUrl

  • prepareExternalUrl(internal: string): string

  • Parameters

    • internal: string

    Returns string

pushState

  • pushState(state: any, title: string, url: string): void

  • Parameters

    • state: any
    • title: string
    • url: string

    Returns void

replaceState

  • replaceState(state: any, title: string, url: string): void

  • Parameters

    • state: any
    • title: string
    • url: string

    Returns void

toJSON

  • toJSON(): any

  • Returns any

PopStateEvent

PopStateEvent:

constructor

  • Parameters

    • state: any

    Returns PopStateEvent

state

state: any

type

type: string

toJSON

  • toJSON(): object

  • Returns object

    • state: any

State

State:

constructor

  • new State(state: any, title: string, url: string): State

  • Parameters

    • state: any
    • title: string
    • url: string

    Returns State

state

state: any

title

title: string

url

url: string

toJSON

  • toJSON(): object

  • Returns object

    • state: any
    • title: string
    • url: string

LocationConfig

LocationConfig:

hash

hash: string

pathname

pathname: string

search

search: string

NodeLocationConfig

NodeLocationConfig:

hash

hash: string

host

host: string

hostname

hostname: string

href

href: string

pathname

pathname: string

port

port: string

protocol

protocol: string

search

search: string

joinWithSlash

  • joinWithSlash(start: string, end: string): string

  • Parameters

    • start: string
    • end: string

    Returns string

config

config: object

hash

hash: any

host

host: any

hostname

hostname: any

href

href: any

pathname

pathname: any

port

port: any

protocol

protocol: any

search

search: any

"node_modules/angular2-universal/src/node/stringify_element"

"node_modules/angular2-universal/src/node/stringify_element":

DOM

DOM: any

_singleTagWhitelist

_singleTagWhitelist: Array<string>

stringifyElement

  • stringifyElement(el: any): string

  • Parameters

    • el: any

    Returns string

"node_modules/angular2-universal/src/node/test/router/node_platform_location.spec"

"node_modules/angular2-universal/src/node/test/router/node_platform_location.spec":

jasmine

jasmine: any

back

  • Parameters

    Returns void

expectProperties

  • Parameters

    Returns void

forward

  • Parameters

    Returns void

normalizeProperties

  • normalizeProperties(__namedParameters: object): object

  • Parameters

    • __namedParameters: object
      • hash: any
      • pathname: any
      • search: any

    Returns object

    • hash: any
    • pathname: any
    • search: any

"node_modules/angular2-universal/src/polyfills"

"node_modules/angular2-universal/src/polyfills":

"node_modules/angular2-universal/src/typings"

"node_modules/angular2-universal/src/typings":

"node_modules/preboot/src/browser/app_manager"

"node_modules/preboot/src/browser/app_manager":

nodeCache

nodeCache: object

Type declaration

state

state: GlobalState

addApp

  • Parameters

    Returns object

    • appRoot: null
    • appRootName: string
    • body: null
    • canComplete: boolean
    • clientRoot: null
    • completeCalled: boolean
    • document: null
    • freeze: null
    • opts: PrebootOptions
    • serverRoot: null
    • started: boolean
    • window: null

addNodeToBody

  • addNodeToBody(app: AppState, type: string, className: string, styles: Object): Element

  • Create a new element

    Parameters

    • app: AppState
    • type: string
    • className: string
    • styles: Object

    Returns Element

appContains

  • Check to see if the app contains a particular node

    Parameters

    Returns any

dispatchGlobalEvent

  • dispatchGlobalEvent(app: AppState, eventName: string): void

  • Dispatch an event on the document

    Parameters

    Returns void

dispatchNodeEvent

  • Dispatch an event on a specific node

    Parameters

    Returns void

findClientNode

  • Given a node from the server rendered view, find the equivalent node in the client rendered view.

    Parameters

    Returns Element

getAllAppNodes

  • Get all app nodes for a given selector

    Parameters

    Returns Element[]

getApp

  • Parameters

    • appRoot: string

    Returns AppState

getAppNode

  • Get one app node

    Parameters

    Returns Element

getClientNodes

  • Get all nodes under the client root

    Parameters

    Returns Element[]

getDocumentNode

  • Get a node in the document

    Parameters

    Returns Element

getNodeKey

  • Get a unique key for a node in the DOM

    Parameters

    Returns string

getSelection

  • Get the caret position within a given node. Some hackery in here to make sure this works in all browsers

    Parameters

    Returns CursorSelection

initAppRoot

  • initAppRoot(app: AppState, options: any): any

  • Parameters

    Returns any

on

  • on(app: AppState, eventName: string, handler: Function): void

  • These are global events that get passed around. Currently we use the document to do this.

    Parameters

    • app: AppState
    • eventName: string
    • handler: Function

    Returns void

onLoad

  • onLoad(app: AppState, handler: Function): void

  • Add event listener at window level

    Parameters

    Returns void

removeNode

  • Remove a node since we are done with it

    Parameters

    Returns void

setSelection

  • Set caret position in a given node

    Parameters

    Returns void

updateAppRoots

  • updateAppRoots(app: AppState, appRoot: any, serverRoot?: any, clientRoot?: any): void

  • Parameters

    • app: AppState
    • appRoot: any
    • Optional serverRoot: any
    • Optional clientRoot: any

    Returns void

"node_modules/preboot/src/browser/buffer_manager"

"node_modules/preboot/src/browser/buffer_manager":

prep

  • Create a second div that will be the client root for an app

    Parameters

    Returns void

switchBuffer

  • We want to simultaneously remove the server node from the DOM and display the client node

    Parameters

    Returns void

state

state: object

switched

switched: boolean

"node_modules/preboot/src/browser/event_manager"

"node_modules/preboot/src/browser/event_manager":

caretPositionEvents

caretPositionEvents: Array<string>

caretPositionNodes

caretPositionNodes: Array<string>

addEventListeners

  • Loop through node events and add listeners

    Parameters

    Returns void

cleanup

  • Go through all the event listeners and clean them up by removing them from the given node (i.e. element)

    Parameters

    Returns void

getEventHandler

  • For a given node, add an event listener based on the given attribute. The attribute must match the Angular pattern for event handlers (i.e. either (event)='blah()' or on-event='blah'

    Parameters

    Returns Function

replayEvents

  • Loop through replay strategies and call replayEvents functions. In most cases there will be only one replay strategy, but users may want to add multiple in some cases with the remaining events from one feeding into the next. Note that as with startListening() above, there are very little safety checks here in getting the replayEvents fn because those checks are in normalize.ts.

    Parameters

    Returns void

startListening

  • Add event listeners based on node events found by the listen strategies. Note that the getNodeEvents fn is gathered here without many safety checks because we are doing all of those in src/server/normalize.ts.

    Parameters

    Returns void

state

state: object

eventListeners

eventListeners: Array<undefined>

events

events: Array<undefined>

listening

listening: boolean

strategies

strategies: object

listen

listen: object

attributes

attributes: "node_modules/preboot/src/browser/listen/listen_by_attributes"

event_bindings

event_bindings: "node_modules/preboot/src/browser/listen/listen_by_event_bindings"

selectors

selectors: "node_modules/preboot/src/browser/listen/listen_by_selectors"

replay

replay: object

hydrate

hydrate: "node_modules/preboot/src/browser/replay/replay_after_hydrate"

rerender

rerender: "node_modules/preboot/src/browser/replay/replay_after_rerender"

"node_modules/preboot/src/browser/freeze/freeze_with_spinner"

"node_modules/preboot/src/browser/freeze/freeze_with_spinner":

cleanup

  • Clean up the freeze elements from the DOM

    Parameters

    Returns void

prep

  • prep(app: any, appState: AppState): void

  • Prepare for freeze by adding elements to the DOM and adding an event handler

    Parameters

    Returns void

state

state: object

overlay

overlay: null

spinner

spinner: null

"node_modules/preboot/src/browser/listen/listen_by_attributes"

"node_modules/preboot/src/browser/listen/listen_by_attributes":

getNodeEvents

  • This listen strategy will look for a specific attribute which contains all the elements that a given element is listening to. For ex.

    Parameters

    Returns NodeEvent[]

"node_modules/preboot/src/browser/listen/listen_by_event_bindings"

"node_modules/preboot/src/browser/listen/listen_by_event_bindings":

ngEventPattern

ngEventPattern: RegExp

addNodeEvents

  • addNodeEvents(node: any): void

  • This is function called at each node while walking DOM. Will add node event if events defined on element.

    Parameters

    • node: any

    Returns void

getNodeEvents

  • This listen strategy will look for a specific attribute which contains all the elements that a given element is listening to.

    Parameters

    Returns NodeEvent[]

walkDOM

  • walkDOM(node: any, func: Function): void

  • This is from Crockford to walk the DOM (http: //whlp.ly/1Ii6YbR). Recursively walk DOM tree and execute input param function at each node.

    Parameters

    • node: any
    • func: Function

    Returns void

state

state: object

nodeEvents

nodeEvents: Array<undefined>

"node_modules/preboot/src/browser/listen/listen_by_selectors"

"node_modules/preboot/src/browser/listen/listen_by_selectors":

getNodeEvents

  • This listen strategy uses a list of selectors maped to events. For example: { 'input[type="text"],textarea': ['focusin', 'focusout'], 'button': ['click'] }

    Parameters

    Returns NodeEvent[]

"node_modules/preboot/src/browser/log"

"node_modules/preboot/src/browser/log":

log

  • log(...args: Array<any>): void

  • Idea here is simple. If debugging turned on and this module exists, we log various things that happen in preboot. The calling code only references a number (keys in logMap) to a handling function. By doing this, we are able to cut down on the amount of logging code in preboot when no in debug mode.

    Parameters

    • Rest ...args: Array<any>

    Returns void

logEvents

  • Parameters

    Returns void

logOptions

  • Parameters

    Returns void

missingClientNode

  • missingClientNode(serverNode: Element): void

  • Parameters

    Returns void

noRefocus

  • noRefocus(serverNode: Element): void

  • Parameters

    Returns void

remainingEvents

  • Parameters

    Returns void

replaySuccess

  • replaySuccess(serverNode: Element, clientNode: Element, event: any): void

  • Parameters

    Returns void

logMap

logMap: object

1

1: logOptions

2

2: logEvents

3

3: replaySuccess

4

4: missingClientNode

5

5: remainingEvents

6

6: noRefocus

"node_modules/preboot/src/browser/preboot_browser"

"node_modules/preboot/src/browser/preboot_browser":

state

state: GlobalState

complete

  • complete(appName: string): void

  • Once bootstrap has completed, we replay events, switch buffer and then cleanup

    Parameters

    • appName: string

    Returns void

completeApp

  • Parameters

    Returns void

init

  • Initialization is really simple. Just save the options and set the window object. Most stuff happens with start() * To call multiple times like init('app1', {}), init('app2', {})

    Parameters

    Returns void

load

  • load(appName: string): void

  • Get function to run once window has loaded

    Parameters

    • appName: string

    Returns void

loadApp

  • Parameters

    Returns void

resume

  • resume(appName: string): void

  • Resume the completion process; if complete already called, call it again right away

    Parameters

    • appName: string

    Returns void

resumeApp

  • Parameters

    Returns void

start

  • start(appName?: string): void

  • Start preboot by starting to record events

    Parameters

    • Optional appName: string

    Returns void

startApp

  • Parameters

    Returns void

"node_modules/preboot/src/browser/preboot_state"

"node_modules/preboot/src/browser/preboot_state":

PrebootState

PrebootState: GlobalState

state

state: object

apps

apps: [AppState]

"node_modules/preboot/src/browser/replay/replay_after_hydrate"

"node_modules/preboot/src/browser/replay/replay_after_hydrate":

replayEvents

  • this replay strategy assumes that the browser did not blow away the server generated HTML and that the elements in memory for preboot can be used to replay the events.

    any events that could not be replayed for whatever reason are returned.

    Parameters

    Returns PrebootEvent[]

"node_modules/preboot/src/browser/replay/replay_after_rerender"

"node_modules/preboot/src/browser/replay/replay_after_rerender":

replayEvents

  • This replay strategy assumes that the browser completely re-rendered the page so reboot will need to find the element in the new browser rendered DOM that matches the element it has in memory.

    Any events that could not be replayed for whatever reason are returned.

    Parameters

    Returns PrebootEvent[]

"node_modules/preboot/src/interfaces/app"

"node_modules/preboot/src/interfaces/app":

App

App:

addApp

  • Parameters

    Returns any

addNodeToBody

  • addNodeToBody(app: AppState, type: string, className: string, styles: Object): Element

  • Parameters

    • app: AppState
    • type: string
    • className: string
    • styles: Object

    Returns Element

appContains

  • Parameters

    Returns any

dispatchGlobalEvent

  • dispatchGlobalEvent(app: AppState, eventName: string): any

  • Parameters

    Returns any

dispatchNodeEvent

  • Parameters

    Returns any

findClientNode

  • Parameters

    Returns Element

getAllAppNodes

  • Parameters

    Returns Element[]

getApp

  • getApp(appRoot: string): any

  • Parameters

    • appRoot: string

    Returns any

getAppNode

  • Parameters

    Returns Element

getClientNodes

  • Parameters

    Returns Element[]

getDocumentNode

  • Parameters

    Returns Element

getNodeKey

  • Parameters

    Returns string

getSelection

initAppRoot

  • initAppRoot(app: AppState, options: any): any

  • Parameters

    Returns any

on

  • on(app: AppState, eventName: string, handler: Function): any

  • Parameters

    • app: AppState
    • eventName: string
    • handler: Function

    Returns any

onLoad

  • onLoad(app: AppState, handler: Function): any

  • Parameters

    Returns any

removeNode

  • Parameters

    Returns any

setSelection

  • Parameters

    Returns any

updateAppRoots

  • updateAppRoots(app: AppState, appRoot: any, serverRoot?: any, clientRoot?: any): any

  • Parameters

    • app: AppState
    • appRoot: any
    • Optional serverRoot: any
    • Optional clientRoot: any

    Returns any

AppState

AppState:

activeNode

activeNode: any

appRoot

appRoot: any

appRootName

appRootName: string

body

body: any

canComplete

canComplete: boolean

clientRoot

clientRoot: any

completeCalled

completeCalled: boolean

document

document: any

freeze

freeze: any

opts

opts: PrebootOptions

selection

selection: CursorSelection

serverRoot

serverRoot: any

started

started: boolean

switched

switched: boolean

window

window: any

GlobalState

GlobalState:

apps

apps: [AppState]

"node_modules/preboot/src/interfaces/element"

"node_modules/preboot/src/interfaces/element":

Element

Element:

attributes

attributes: string[]

checked

checked: boolean

childNodes

childNodes: Element[]

className

className: string

id

id: string

nodeName

nodeName: string

parentNode

parentNode: Element

selected

selected: boolean

selection

selection: any

selectionDirection

selectionDirection: string

selectionEnd

selectionEnd: number

selectionStart

selectionStart: number

style

style: Style

tagName

tagName: string

value

value: string

cloneNode

  • cloneNode(deep: boolean): Element

  • Parameters

    • deep: boolean

    Returns Element

createTextRange

  • createTextRange(): any

  • Returns any

dispatchEvent

  • Parameters

    Returns any

focus

  • focus(): any

  • Returns any

getAttribute

  • getAttribute(name: string): string

  • Parameters

    • name: string

    Returns string

insertBefore

  • Parameters

    Returns any

remove

  • remove(): any

  • Returns any

setSelectionRange

  • setSelectionRange(fromPos: number, toPos: number, direction: string): any

  • Parameters

    • fromPos: number
    • toPos: number
    • direction: string

    Returns any

Style

Style:

display

display: string

"node_modules/preboot/src/interfaces/event"

"node_modules/preboot/src/interfaces/event":

DomEvent

DomEvent:

target

target: any

type

type: string

which

which: number

preventDefault

  • preventDefault(): any

  • Returns any

NodeEvent

NodeEvent:

eventName

eventName: string

node

node: any

PrebootEvent

PrebootEvent:

appName

appName: string

event

event: any

name

name: string

node

node: any

nodeKey

nodeKey: any

time

time: number

"node_modules/preboot/src/interfaces/preboot_options"

"node_modules/preboot/src/interfaces/preboot_options":

FreezeStyles

FreezeStyles:

overlay

overlay: Styles

spinner

spinner: Styles

PrebootOptions

PrebootOptions:

appRoot

appRoot: [string]

buffer

buffer: boolean

completeEvent

completeEvent: string

debug

debug: boolean

disableCodeCache

disableCodeCache: boolean

freeze

freeze: any

listen

listen: any

pauseEvent

pauseEvent: string

presets

presets: any

replay

replay: any

resumeEvent

resumeEvent: string

uglify

uglify: boolean

Styles

Styles:

className

className: string

style

style: Object

"node_modules/preboot/src/interfaces/preboot_ref"

"node_modules/preboot/src/interfaces/preboot_ref":

CursorSelection

CursorSelection:

direction

direction: string

end

end: number

start

start: number

Dom

Dom:

addNodeToBody

  • addNodeToBody(app: AppState, type: string, className: string, styles: Object): Element

  • Parameters

    • app: AppState
    • type: string
    • className: string
    • styles: Object

    Returns Element

appContains

  • Parameters

    Returns Boolean

dispatchGlobalEvent

  • dispatchGlobalEvent(app: AppState, eventName: string): any

  • Parameters

    Returns any

dispatchNodeEvent

  • Parameters

    Returns any

findClientNode

  • Parameters

    Returns Element

getAllAppNodes

  • Parameters

    Returns Element[]

getAppNode

  • Parameters

    Returns Element

getClientNodes

  • Parameters

    Returns Element[]

getDocumentNode

  • Parameters

    Returns Element

getNodeKey

  • Parameters

    Returns string

getSelection

  • Parameters

    Returns CursorSelection

on

  • on(eventName: string, handler: Function): any

  • Parameters

    • eventName: string
    • handler: Function

    Returns any

onLoad

  • onLoad(handler: Function): any

  • Parameters

    • handler: Function

    Returns any

removeNode

  • Parameters

    Returns any

setSelection

  • Parameters

    Returns any

"node_modules/preboot/src/interfaces/strategy"

"node_modules/preboot/src/interfaces/strategy":

ListenStrategy

ListenStrategy:

attributeName

attributeName: string

dispatchEvent

dispatchEvent: string

doNotReplay

doNotReplay: boolean

eventsBySelector

eventsBySelector: Object

name

name: string

preventDefault

preventDefault: boolean

trackFocus

trackFocus: boolean

action

  • Parameters

    Returns any

ReplayStrategy

ReplayStrategy:

checkIfExists

checkIfExists: boolean

name

name: string

"node_modules/preboot/src/node/browser_code_generator"

"node_modules/preboot/src/node/browser_code_generator":

browserCodeCache

browserCodeCache: object

Type declaration

getClientCode

getClientCode: getBrowserCode

getClientCodeStream

getClientCodeStream: getBrowserCodeStream

getBrowserCode

  • getBrowserCode(appName: string, opts?: PrebootOptions, done?: Function): any

  • Generate browser code as a string for preboot based on the input options

    Parameters

    • appName: string
    • Optional opts: PrebootOptions
    • Optional done: Function

    Returns any

getBrowserCodeStream

  • Generate browser code as a readable stream for preboot based on the input options

    Parameters

    Returns any

ignoreUnusedStrategies

  • ignoreUnusedStrategies(b: any, bOpts: Object, strategyOpts: any[], allStrategies: Object, pathPrefix: string): void

  • We want to use the browserify ignore functionality so that any code modules that are not being used are stubbed out. So, for example, if in the preboot options the only listen strategy is selectors, then the event_bindings and attributes strategies will be stubbed out (meaing the refs will be {})

    Parameters

    • b: any
    • bOpts: Object
    • strategyOpts: any[]
    • allStrategies: Object
    • pathPrefix: string

    Returns void

"node_modules/preboot/src/node/normalize"

"node_modules/preboot/src/node/normalize":

normalize

  • Normalize options so user can enter shorthand and it is expanded as appropriate for the browser code

    Parameters

    Returns PrebootOptions

defaultFreezeStyles

defaultFreezeStyles: object

overlay

overlay: object

className

className: string

style

style: object

display

display: string

height

height: string

left

left: string

position

position: string

top

top: string

width

width: string

zIndex

zIndex: string

spinner

spinner: object

className

className: string

style

style: object

display

display: string

position

position: string

zIndex

zIndex: string

freezeStrategies

freezeStrategies: object

spinner

spinner: boolean

listenStrategies

listenStrategies: object

attributes

attributes: boolean

event_bindings

event_bindings: boolean

selectors

selectors: boolean

normalizers

normalizers: object

completeEvent

  • Parameters

    Returns void

freeze

  • Make sure freeze options are array of FreezeStrategy objects. We have a set of base styles that are used for freeze (i.e. for overaly and spinner), but these can be overriden

    Parameters

    Returns void

listen

  • Make sure that the listen option is an array of ListenStrategy objects so client side doesn't need to worry about conversions

    Parameters

    Returns void

pauseEvent

  • Just set default pauseEvent if doesn't exist

    Parameters

    Returns void

presets

  • Presets are modifications to options. In the future, we may be simple presets like 'angular' which add all the listeners and replay.

    Parameters

    Returns void

replay

  • Make sure replay options are array of ReplayStrategy objects. So, callers can just pass in simple string, but converted to an array before passed into client side preboot.

    Parameters

    Returns void

resumeEvent

  • Set default resumeEvent if doesn't exist

    Parameters

    Returns void

replayStrategies

replayStrategies: object

hydrate

hydrate: boolean

rerender

rerender: boolean

"node_modules/preboot/src/node/preboot_node"

"node_modules/preboot/src/node/preboot_node":

"node_modules/preboot/src/node/presets"

"node_modules/preboot/src/node/presets":

"node_modules/preboot/src/node/utils"

"node_modules/preboot/src/node/utils":

FUNC_START

FUNC_START: string

FUNC_STOP

FUNC_STOP: string

stringifyWithFunctions

  • stringifyWithFunctions(obj: Object): String

  • Stringify an object and include functions

    Parameters

    • obj: Object

    Returns String

"node_modules/reflect-metadata/Reflect"

"node_modules/reflect-metadata/Reflect":

Reflect

Reflect:

BufferLike

BufferLike:

length

length: number

Map

Map:

size

size: number

clear

  • clear(): void

  • Returns void

delete

  • delete(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Parameters

    • callbackfn: function
        • (value: V, index: K, map: Map<K, V>): void

        • Parameters

          • value: V
          • index: K
          • map: Map<K, V>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key: K): V

  • Parameters

    • key: K

    Returns V

has

  • has(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

set

  • set(key: K, value?: V): Map<K, V>

  • Parameters

    • key: K
    • Optional value: V

    Returns Map<K, V>

MapConstructor

MapConstructor:

constructor

  • Returns MapConstructor

  • Type parameters

    • K

    • V

    Returns MapConstructor

prototype

prototype: Map<any, any>

Set

Set:

size

size: number

add

  • add(value: T): Set<T>

  • Parameters

    • value: T

    Returns Set<T>

clear

  • clear(): void

  • Returns void

delete

  • delete(value: T): boolean

  • Parameters

    • value: T

    Returns boolean

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Parameters

    • callbackfn: function
        • (value: T, index: T, set: Set<T>): void

        • Parameters

          • value: T
          • index: T
          • set: Set<T>

          Returns void

    • Optional thisArg: any

    Returns void

has

  • has(value: T): boolean

  • Parameters

    • value: T

    Returns boolean

SetConstructor

SetConstructor:

constructor

  • Returns SetConstructor

  • Type parameters

    • T

    Returns SetConstructor

prototype

prototype: Set<any>

WeakMap

WeakMap:

clear

  • clear(): void

  • Returns void

delete

  • delete(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

get

  • get(key: K): V

  • Parameters

    • key: K

    Returns V

has

  • has(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

set

  • set(key: K, value?: V): WeakMap<K, V>

  • Parameters

    • key: K
    • Optional value: V

    Returns WeakMap<K, V>

WeakMapConstructor

WeakMapConstructor:

constructor

  • Returns WeakMapConstructor

  • Type parameters

    • K

    • V

    Returns WeakMapConstructor

prototype

prototype: WeakMap<any, any>

WorkerGlobalScope

WorkerGlobalScope: any

_Map

_Map: MapConstructor

_Set

_Set: SetConstructor

_WeakMap

_WeakMap: WeakMapConstructor

___Metadata__

___Metadata__: WeakMap<Object, Map<string | symbol, Map<any, any>>>

crypto

crypto: Crypto

functionPrototype

functionPrototype: any

global

global: any

module

module: any

msCrypto

msCrypto: Crypto

require

require: Function

CreateMapPolyfill

  • CreateMapPolyfill(): any

  • Returns any

CreateSetPolyfill

  • CreateSetPolyfill(): any

  • Returns any

CreateWeakMapPolyfill

  • CreateWeakMapPolyfill(): any

  • Returns any

DecorateConstructor

  • DecorateConstructor(decorators: ClassDecorator[], target: Function): Function

  • Parameters

    • decorators: ClassDecorator[]
    • target: Function

    Returns Function

DecoratePropertyWithDescriptor

  • DecoratePropertyWithDescriptor(decorators: MethodDecorator[], target: Object, propertyKey: string | symbol, descriptor: PropertyDescriptor): PropertyDescriptor

  • Parameters

    • decorators: MethodDecorator[]
    • target: Object
    • propertyKey: string | symbol
    • descriptor: PropertyDescriptor

    Returns PropertyDescriptor

DecoratePropertyWithoutDescriptor

  • DecoratePropertyWithoutDescriptor(decorators: PropertyDecorator[], target: Object, propertyKey: string | symbol): void

  • Parameters

    • decorators: PropertyDecorator[]
    • target: Object
    • propertyKey: string | symbol

    Returns void

GetOrCreateMetadataMap

  • GetOrCreateMetadataMap(target: Object, targetKey: string | symbol, create: boolean): Map<any, any>

  • Parameters

    • target: Object
    • targetKey: string | symbol
    • create: boolean

    Returns Map<any, any>

GetPrototypeOf

  • GetPrototypeOf(O: any): Object

  • Parameters

    • O: any

    Returns Object

IsArray

  • IsArray(x: any): boolean

  • Parameters

    • x: any

    Returns boolean

IsConstructor

  • IsConstructor(x: any): boolean

  • Parameters

    • x: any

    Returns boolean

IsObject

  • IsObject(x: any): boolean

  • Parameters

    • x: any

    Returns boolean

IsSymbol

  • IsSymbol(x: any): boolean

  • Parameters

    • x: any

    Returns boolean

IsUndefined

  • IsUndefined(x: any): boolean

  • Parameters

    • x: any

    Returns boolean

OrdinaryDefineOwnMetadata

  • OrdinaryDefineOwnMetadata(MetadataKey: any, MetadataValue: any, O: Object, P: string | symbol): void

  • Parameters

    • MetadataKey: any
    • MetadataValue: any
    • O: Object
    • P: string | symbol

    Returns void

OrdinaryGetMetadata

  • OrdinaryGetMetadata(MetadataKey: any, O: Object, P: string | symbol): any

  • Parameters

    • MetadataKey: any
    • O: Object
    • P: string | symbol

    Returns any

OrdinaryGetOwnMetadata

  • OrdinaryGetOwnMetadata(MetadataKey: any, O: Object, P: string | symbol): any

  • Parameters

    • MetadataKey: any
    • O: Object
    • P: string | symbol

    Returns any

OrdinaryHasMetadata

  • OrdinaryHasMetadata(MetadataKey: any, O: Object, P: string | symbol): boolean

  • Parameters

    • MetadataKey: any
    • O: Object
    • P: string | symbol

    Returns boolean

OrdinaryHasOwnMetadata

  • OrdinaryHasOwnMetadata(MetadataKey: any, O: Object, P: string | symbol): boolean

  • Parameters

    • MetadataKey: any
    • O: Object
    • P: string | symbol

    Returns boolean

OrdinaryMetadataKeys

  • OrdinaryMetadataKeys(O: Object, P: string | symbol): any[]

  • Parameters

    • O: Object
    • P: string | symbol

    Returns any[]

OrdinaryOwnMetadataKeys

  • OrdinaryOwnMetadataKeys(target: Object, targetKey: string | symbol): any[]

  • Parameters

    • target: Object
    • targetKey: string | symbol

    Returns any[]

ToPropertyKey

  • ToPropertyKey(value: any): string | symbol

  • Parameters

    • value: any

    Returns string | symbol

decorate

  • decorate(decorators: ClassDecorator[], target: Function): Function
  • decorate(decorators: function | function, target: Object, targetKey: string | symbol, descriptor?: PropertyDescriptor): PropertyDescriptor

  • Applies a set of decorators to a target object.

    remarks

    Decorators are applied in reverse order of their positions in the array.

    example
    class C { }

// constructor
C = Reflect.decorate(decoratorsArray, C);

    Parameters

    • decorators: ClassDecorator[]

      An array of decorators.

    • target: Function

      The target object.

    Returns Function

    The result of applying the provided decorators.

  • Applies a set of decorators to a property of a target object.

    remarks

    Decorators are applied in reverse order.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod() { }
    method() { }
}

// property (on constructor)
Reflect.decorate(decoratorsArray, C, "staticProperty");

// property (on prototype)
Reflect.decorate(decoratorsArray, C.prototype, "property");

// method (on constructor)
Object.defineProperty(C, "staticMethod",
    Reflect.decorate(decoratorsArray, C, "staticMethod",
        Object.getOwnPropertyDescriptor(C, "staticMethod")));

// method (on prototype)
Object.defineProperty(C.prototype, "method",
    Reflect.decorate(decoratorsArray, C.prototype, "method",
        Object.getOwnPropertyDescriptor(C.prototype, "method")));

    Parameters

    • decorators: function | function

      An array of decorators.

    • target: Object

      The target object.

    • targetKey: string | symbol

      (Optional) The property key to decorate.

    • Optional descriptor: PropertyDescriptor

      A property descriptor

    Returns PropertyDescriptor

defineMetadata

  • defineMetadata(metadataKey: any, metadataValue: any, target: Object): void
  • defineMetadata(metadataKey: any, metadataValue: any, target: Object, targetKey: string | symbol): void

  • Define a unique metadata entry on the target.

    example
    class C {
}

// constructor
Reflect.defineMetadata("custom:annotation", options, C);

// decorator factory as metadata-producing annotation.
function MyAnnotation(options): ClassDecorator {
    return target => Reflect.defineMetadata("custom:annotation", options, target);
}

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • metadataValue: any

      A value that contains attached metadata.

    • target: Object

      The target object on which to define metadata.

    Returns void

  • Define a unique metadata entry on the target.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
Reflect.defineMetadata("custom:annotation", Number, C, "staticProperty");

// property (on prototype)
Reflect.defineMetadata("custom:annotation", Number, C.prototype, "property");

// method (on constructor)
Reflect.defineMetadata("custom:annotation", Number, C, "staticMethod");

// method (on prototype)
Reflect.defineMetadata("custom:annotation", Number, C.prototype, "method");

// decorator factory as metadata-producing annotation.
function MyAnnotation(options): PropertyDecorator {
    return (target, key) => Reflect.defineMetadata("custom:annotation", options, target, key);
}

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • metadataValue: any

      A value that contains attached metadata.

    • target: Object

      The target object on which to define metadata.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns void

deleteMetadata

  • deleteMetadata(metadataKey: any, target: Object): boolean
  • deleteMetadata(metadataKey: any, target: Object, targetKey: string | symbol): boolean

  • Deletes the metadata entry from the target object with the provided key.

    example
    class C {
}

// constructor
result = Reflect.deleteMetadata("custom:annotation", C);

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    Returns boolean

    true if the metadata entry was found and deleted; otherwise, false.

  • Deletes the metadata entry from the target object with the provided key.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.deleteMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.deleteMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.deleteMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.deleteMetadata("custom:annotation", C.prototype, "method");

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns boolean

    true if the metadata entry was found and deleted; otherwise, false.

getMetadata

  • getMetadata(metadataKey: any, target: Object): any
  • getMetadata(metadataKey: any, target: Object, targetKey: string | symbol): any

  • Gets the metadata value for the provided metadata key on the target object or its prototype chain.

    example
    class C {
}

// constructor
result = Reflect.getMetadata("custom:annotation", C);

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    Returns any

    The metadata value for the metadata key if found; otherwise, undefined.

  • Gets the metadata value for the provided metadata key on the target object or its prototype chain.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.getMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.getMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.getMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.getMetadata("custom:annotation", C.prototype, "method");

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns any

    The metadata value for the metadata key if found; otherwise, undefined.

getMetadataKeys

  • getMetadataKeys(target: Object): any[]
  • getMetadataKeys(target: Object, targetKey: string | symbol): any[]

  • Gets the metadata keys defined on the target object or its prototype chain.

    example
    class C {
}

// constructor
result = Reflect.getMetadataKeys(C);

    Parameters

    • target: Object

      The target object on which the metadata is defined.

    Returns any[]

    An array of unique metadata keys.

  • Gets the metadata keys defined on the target object or its prototype chain.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.getMetadataKeys(C, "staticProperty");

// property (on prototype)
result = Reflect.getMetadataKeys(C.prototype, "property");

// method (on constructor)
result = Reflect.getMetadataKeys(C, "staticMethod");

// method (on prototype)
result = Reflect.getMetadataKeys(C.prototype, "method");

    Parameters

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns any[]

    An array of unique metadata keys.

getOwnMetadata

  • getOwnMetadata(metadataKey: any, target: Object): any
  • getOwnMetadata(metadataKey: any, target: Object, targetKey: string | symbol): any

  • Gets the metadata value for the provided metadata key on the target object.

    example
    class C {
}

// constructor
result = Reflect.getOwnMetadata("custom:annotation", C);

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    Returns any

    The metadata value for the metadata key if found; otherwise, undefined.

  • Gets the metadata value for the provided metadata key on the target object.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.getOwnMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.getOwnMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.getOwnMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.getOwnMetadata("custom:annotation", C.prototype, "method");

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns any

    The metadata value for the metadata key if found; otherwise, undefined.

getOwnMetadataKeys

  • getOwnMetadataKeys(target: Object): any[]
  • getOwnMetadataKeys(target: Object, targetKey: string | symbol): any[]

  • Gets the unique metadata keys defined on the target object.

    example
    class C {
}

// constructor
result = Reflect.getOwnMetadataKeys(C);

    Parameters

    • target: Object

      The target object on which the metadata is defined.

    Returns any[]

    An array of unique metadata keys.

  • Gets the unique metadata keys defined on the target object.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.getOwnMetadataKeys(C, "staticProperty");

// property (on prototype)
result = Reflect.getOwnMetadataKeys(C.prototype, "property");

// method (on constructor)
result = Reflect.getOwnMetadataKeys(C, "staticMethod");

// method (on prototype)
result = Reflect.getOwnMetadataKeys(C.prototype, "method");

    Parameters

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns any[]

    An array of unique metadata keys.

hasMetadata

  • hasMetadata(metadataKey: any, target: Object): boolean
  • hasMetadata(metadataKey: any, target: Object, targetKey: string | symbol): boolean

  • Gets a value indicating whether the target object or its prototype chain has the provided metadata key defined.

    example
    class C {
}

// constructor
result = Reflect.hasMetadata("custom:annotation", C);

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    Returns boolean

    true if the metadata key was defined on the target object or its prototype chain; otherwise, false.

  • Gets a value indicating whether the target object or its prototype chain has the provided metadata key defined.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.hasMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.hasMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.hasMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.hasMetadata("custom:annotation", C.prototype, "method");

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns boolean

    true if the metadata key was defined on the target object or its prototype chain; otherwise, false.

hasOwnMetadata

  • hasOwnMetadata(metadataKey: any, target: Object): boolean
  • hasOwnMetadata(metadataKey: any, target: Object, targetKey: string | symbol): boolean

  • Gets a value indicating whether the target object has the provided metadata key defined.

    example
    class C {
}

// constructor
result = Reflect.hasOwnMetadata("custom:annotation", C);

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    Returns boolean

    true if the metadata key was defined on the target object; otherwise, false.

  • Gets a value indicating whether the target object has the provided metadata key defined.

    example
    class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.hasOwnMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.hasOwnMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.hasOwnMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.hasOwnMetadata("custom:annotation", C.prototype, "method");

    Parameters

    • metadataKey: any

      A key used to store and retrieve metadata.

    • target: Object

      The target object on which the metadata is defined.

    • targetKey: string | symbol

      (Optional) The property key for the target.

    Returns boolean

    true if the metadata key was defined on the target object; otherwise, false.

metadata

  • metadata(metadataKey: any, metadataValue: any): decorator

  • A default metadata decorator factory that can be used on a class, class member, or parameter.

    remarks

    If metadataKey is already defined for the target and target key, the metadataValue for that key will be overwritten.

    example
    // constructor
@Reflect.metadata(key, value)
class C {
}

// property (on constructor, TypeScript only)
class C {
    @Reflect.metadata(key, value)
    static staticProperty;
}

// property (on prototype, TypeScript only)
class C {
    @Reflect.metadata(key, value)
    property;
}

// method (on constructor)
class C {
    @Reflect.metadata(key, value)
    static staticMethod() { }
}

// method (on prototype)
class C {
    @Reflect.metadata(key, value)
    method() { }
}

    Parameters

    • metadataKey: any

      The key for the metadata entry.

    • metadataValue: any

      The value for the metadata entry.

    Returns decorator

    A decorator function.

"node_modules/reflect-metadata/test/harness"

"node_modules/reflect-metadata/test/harness":

TestResults

TestResults:

failed

failed: [string, any]

passed

passed: string[]

printResults

  • Parameters

    Returns void

runTests

  • Parameters

    • fixture: any

    Returns TestResults

"node_modules/reflect-metadata/test/reflect/reflect-decorate"

"node_modules/reflect-metadata/test/reflect/reflect-decorate":

ReflectDecorateExecutesDecoratorsInReverseOrderForFunctionOverload

  • ReflectDecorateExecutesDecoratorsInReverseOrderForFunctionOverload(): void

  • Returns void

ReflectDecorateExecutesDecoratorsInReverseOrderForPropertyDescriptorOverload

  • ReflectDecorateExecutesDecoratorsInReverseOrderForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecorateExecutesDecoratorsInReverseOrderForPropertyOverload

  • ReflectDecorateExecutesDecoratorsInReverseOrderForPropertyOverload(): void

  • Returns void

ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForFunctionOverload

  • ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForFunctionOverload(): void

  • Returns void

ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForPropertyDescriptorOverload

  • ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForPropertyOverload

  • ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForPropertyOverload(): void

  • Returns void

ReflectDecorateThrowsIfTargetArgumentNotFunctionForFunctionOverload

  • ReflectDecorateThrowsIfTargetArgumentNotFunctionForFunctionOverload(): void

  • Returns void

ReflectDecorateThrowsIfTargetArgumentNotObjectForPropertyDescriptorOverload

  • ReflectDecorateThrowsIfTargetArgumentNotObjectForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecorateThrowsIfTargetArgumentNotObjectForPropertyOverload

  • ReflectDecorateThrowsIfTargetArgumentNotObjectForPropertyOverload(): void

  • Returns void

ReflectDecoratorCorrectDescriptorInPipelineForPropertyDescriptorOverload

  • ReflectDecoratorCorrectDescriptorInPipelineForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecoratorCorrectNameInPipelineForPropertyDescriptorOverload

  • ReflectDecoratorCorrectNameInPipelineForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecoratorCorrectNameInPipelineForPropertyOverload

  • ReflectDecoratorCorrectNameInPipelineForPropertyOverload(): void

  • Returns void

ReflectDecoratorCorrectTargetInPipelineForFunctionOverload

  • ReflectDecoratorCorrectTargetInPipelineForFunctionOverload(): void

  • Returns void

ReflectDecoratorCorrectTargetInPipelineForPropertyDescriptorOverload

  • ReflectDecoratorCorrectTargetInPipelineForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecoratorCorrectTargetInPipelineForPropertyOverload

  • ReflectDecoratorCorrectTargetInPipelineForPropertyOverload(): void

  • Returns void

ReflectDecoratorPipelineForFunctionOverload

  • ReflectDecoratorPipelineForFunctionOverload(): void

  • Returns void

ReflectDecoratorPipelineForPropertyDescriptorOverload

  • ReflectDecoratorPipelineForPropertyDescriptorOverload(): void

  • Returns void

ReflectDecoratorPipelineForPropertyOverload

  • ReflectDecoratorPipelineForPropertyOverload(): void

  • Returns void

"node_modules/reflect-metadata/test/reflect/reflect-definemetadata"

"node_modules/reflect-metadata/test/reflect/reflect-definemetadata":

ReflectDefineMetadataInvalidTarget

  • ReflectDefineMetadataInvalidTarget(): void

  • Returns void

ReflectDefineMetadataValidTargetWithTargetKey

  • ReflectDefineMetadataValidTargetWithTargetKey(): void

  • Returns void

ReflectDefineMetadataValidTargetWithoutTargetKey

  • ReflectDefineMetadataValidTargetWithoutTargetKey(): void

  • Returns void

"node_modules/reflect-metadata/test/reflect/reflect-deletemetadata"

"node_modules/reflect-metadata/test/reflect/reflect-deletemetadata":

ReflectDeleteMetadataInvalidTarget

  • ReflectDeleteMetadataInvalidTarget(): void

  • Returns void

ReflectDeleteMetadataWhenDefinedOnPrototypeWithoutTargetKey

  • ReflectDeleteMetadataWhenDefinedOnPrototypeWithoutTargetKey(): void

  • Returns void

ReflectDeleteMetadataWhenDefinedWithoutTargetKey

  • ReflectDeleteMetadataWhenDefinedWithoutTargetKey(): void

  • Returns void

ReflectDeleteMetadataWhenNotDefinedWithoutTargetKey

  • ReflectDeleteMetadataWhenNotDefinedWithoutTargetKey(): void

  • Returns void

ReflectHasOwnMetadataAfterDeleteMetadata

  • ReflectHasOwnMetadataAfterDeleteMetadata(): void

  • Returns void

"node_modules/reflect-metadata/test/reflect/reflect-getmetadata"

"node_modules/reflect-metadata/test/reflect/reflect-getmetadata":

ReflectGetMetadataInvalidTarget

  • ReflectGetMetadataInvalidTarget(): void

  • Returns void

ReflectGetMetadataWithTargetKeyWhenDefined

  • ReflectGetMetadataWithTargetKeyWhenDefined(): void

  • Returns void

ReflectGetMetadataWithTargetKeyWhenDefinedOnPrototype

  • ReflectGetMetadataWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetMetadataWithTargetKeyWhenNotDefined

  • ReflectGetMetadataWithTargetKeyWhenNotDefined(): void

  • Returns void

ReflectGetMetadataWithoutTargetKeyWhenDefined

  • ReflectGetMetadataWithoutTargetKeyWhenDefined(): void

  • Returns void

ReflectGetMetadataWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectGetMetadataWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetMetadataWithoutTargetKeyWhenNotDefined

  • ReflectGetMetadataWithoutTargetKeyWhenNotDefined(): void

  • Returns void

"node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys"

"node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys":

ReflectGetMetadataKeysInvalidTarget

  • ReflectGetMetadataKeysInvalidTarget(): void

  • Returns void

ReflectGetMetadataKeysOrderAfterRedefineWithTargetKey

  • ReflectGetMetadataKeysOrderAfterRedefineWithTargetKey(): void

  • Returns void

ReflectGetMetadataKeysOrderAfterRedefineWithoutTargetKey

  • ReflectGetMetadataKeysOrderAfterRedefineWithoutTargetKey(): void

  • Returns void

ReflectGetMetadataKeysOrderWithTargetKeyWhenDefinedOnPrototype

  • ReflectGetMetadataKeysOrderWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetMetadataKeysOrderWithoutTargetKey

  • ReflectGetMetadataKeysOrderWithoutTargetKey(): void

  • Returns void

ReflectGetMetadataKeysOrderWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectGetMetadataKeysOrderWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetMetadataKeysWithTargetKeyWhenDefined

  • ReflectGetMetadataKeysWithTargetKeyWhenDefined(): void

  • Returns void

ReflectGetMetadataKeysWithTargetKeyWhenDefinedOnPrototype

  • ReflectGetMetadataKeysWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetMetadataKeysWithTargetKeyWhenNotDefined

  • ReflectGetMetadataKeysWithTargetKeyWhenNotDefined(): void

  • Returns void

ReflectGetMetadataKeysWithoutTargetKeyWhenDefined

  • ReflectGetMetadataKeysWithoutTargetKeyWhenDefined(): void

  • Returns void

ReflectGetMetadataKeysWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectGetMetadataKeysWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetMetadataKeysWithoutTargetKeyWhenNotDefined

  • ReflectGetMetadataKeysWithoutTargetKeyWhenNotDefined(): void

  • Returns void

"node_modules/reflect-metadata/test/reflect/reflect-getownmetadata"

"node_modules/reflect-metadata/test/reflect/reflect-getownmetadata":

ReflectGetOwnMetadataInvalidTarget

  • ReflectGetOwnMetadataInvalidTarget(): void

  • Returns void

ReflectGetOwnMetadataWithTargetKeyWhenDefined

  • ReflectGetOwnMetadataWithTargetKeyWhenDefined(): void

  • Returns void

ReflectGetOwnMetadataWithTargetKeyWhenDefinedOnPrototype

  • ReflectGetOwnMetadataWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetOwnMetadataWithTargetKeyWhenNotDefined

  • ReflectGetOwnMetadataWithTargetKeyWhenNotDefined(): void

  • Returns void

ReflectGetOwnMetadataWithoutTargetKeyWhenDefined

  • ReflectGetOwnMetadataWithoutTargetKeyWhenDefined(): void

  • Returns void

ReflectGetOwnMetadataWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectGetOwnMetadataWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetOwnMetadataWithoutTargetKeyWhenNotDefined

  • ReflectGetOwnMetadataWithoutTargetKeyWhenNotDefined(): void

  • Returns void

"node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys"

"node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys":

ReflectGetOwnMetadataKeysKeysInvalidTarget

  • ReflectGetOwnMetadataKeysKeysInvalidTarget(): void

  • Returns void

ReflectGetOwnMetadataKeysOrderAfterRedefineWithTargetKey

  • ReflectGetOwnMetadataKeysOrderAfterRedefineWithTargetKey(): void

  • Returns void

ReflectGetOwnMetadataKeysOrderAfterRedefineWithoutTargetKey

  • ReflectGetOwnMetadataKeysOrderAfterRedefineWithoutTargetKey(): void

  • Returns void

ReflectGetOwnMetadataKeysOrderWithoutTargetKey

  • ReflectGetOwnMetadataKeysOrderWithoutTargetKey(): void

  • Returns void

ReflectGetOwnMetadataKeysWithTargetKeyWhenDefined

  • ReflectGetOwnMetadataKeysWithTargetKeyWhenDefined(): void

  • Returns void

ReflectGetOwnMetadataKeysWithTargetKeyWhenDefinedOnPrototype

  • ReflectGetOwnMetadataKeysWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetOwnMetadataKeysWithTargetKeyWhenNotDefined

  • ReflectGetOwnMetadataKeysWithTargetKeyWhenNotDefined(): void

  • Returns void

ReflectGetOwnMetadataKeysWithoutTargetKeyWhenDefined

  • ReflectGetOwnMetadataKeysWithoutTargetKeyWhenDefined(): void

  • Returns void

ReflectGetOwnMetadataKeysWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectGetOwnMetadataKeysWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectGetOwnMetadataKeysWithoutTargetKeyWhenNotDefined

  • ReflectGetOwnMetadataKeysWithoutTargetKeyWhenNotDefined(): void

  • Returns void

"node_modules/reflect-metadata/test/reflect/reflect-hasmetadata"

"node_modules/reflect-metadata/test/reflect/reflect-hasmetadata":

ReflectHasMetadataInvalidTarget

  • ReflectHasMetadataInvalidTarget(): void

  • Returns void

ReflectHasMetadataWithTargetKeyWhenDefined

  • ReflectHasMetadataWithTargetKeyWhenDefined(): void

  • Returns void

ReflectHasMetadataWithTargetKeyWhenDefinedOnPrototype

  • ReflectHasMetadataWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectHasMetadataWithTargetKeyWhenNotDefined

  • ReflectHasMetadataWithTargetKeyWhenNotDefined(): void

  • Returns void

ReflectHasMetadataWithoutTargetKeyWhenDefined

  • ReflectHasMetadataWithoutTargetKeyWhenDefined(): void

  • Returns void

ReflectHasMetadataWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectHasMetadataWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectHasMetadataWithoutTargetKeyWhenNotDefined

  • ReflectHasMetadataWithoutTargetKeyWhenNotDefined(): void

  • Returns void

"node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata"

"node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata":

ReflectHasOwnMetadataInvalidTarget

  • ReflectHasOwnMetadataInvalidTarget(): void

  • Returns void

ReflectHasOwnMetadataWithTargetKeyWhenDefined

  • ReflectHasOwnMetadataWithTargetKeyWhenDefined(): void

  • Returns void

ReflectHasOwnMetadataWithTargetKeyWhenDefinedOnPrototype

  • ReflectHasOwnMetadataWithTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectHasOwnMetadataWithTargetKeyWhenNotDefined

  • ReflectHasOwnMetadataWithTargetKeyWhenNotDefined(): void

  • Returns void

ReflectHasOwnMetadataWithoutTargetKeyWhenDefined

  • ReflectHasOwnMetadataWithoutTargetKeyWhenDefined(): void

  • Returns void

ReflectHasOwnMetadataWithoutTargetKeyWhenDefinedOnPrototype

  • ReflectHasOwnMetadataWithoutTargetKeyWhenDefinedOnPrototype(): void

  • Returns void

ReflectHasOwnMetadataWithoutTargetKeyWhenNotDefined

  • ReflectHasOwnMetadataWithoutTargetKeyWhenNotDefined(): void

  • Returns void

"node_modules/reflect-metadata/test/reflect/reflect-metadata"

"node_modules/reflect-metadata/test/reflect/reflect-metadata":

ReflectMetadataDecoratorSetsMetadataOnTargetWithTargetKey

  • ReflectMetadataDecoratorSetsMetadataOnTargetWithTargetKey(): void

  • Returns void

ReflectMetadataDecoratorSetsMetadataOnTargetWithoutTargetKey

  • ReflectMetadataDecoratorSetsMetadataOnTargetWithoutTargetKey(): void

  • Returns void

ReflectMetadataDecoratorThrowsWithInvalidTargetWithTargetKey

  • ReflectMetadataDecoratorThrowsWithInvalidTargetWithTargetKey(): void

  • Returns void

ReflectMetadataDecoratorThrowsWithInvalidTargetWithoutTargetKey

  • ReflectMetadataDecoratorThrowsWithInvalidTargetWithoutTargetKey(): void

  • Returns void

ReflectMetadataReturnsDecoratorFunction

  • ReflectMetadataReturnsDecoratorFunction(): void

  • Returns void

"node_modules/reflect-metadata/test/run"

"node_modules/reflect-metadata/test/run":

results

results: TestResults

"node_modules/reflect-metadata/test/spec"

"node_modules/reflect-metadata/test/spec":

"node_modules/rxjs/src/AsyncSubject"

"node_modules/rxjs/src/AsyncSubject":

AsyncSubject

AsyncSubject:
class

AsyncSubject

constructor

_isScalar

_isScalar: boolean

destination

destination: Observer<T>

dispatching

dispatching: boolean

errorValue

errorValue: any

hasCompleted

hasCompleted: boolean

hasErrored

hasErrored: boolean

hasNext

hasNext: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

observers

observers: Observer<T>[]

operator

operator: Operator<any, T>

source

source: Observable<T>

value

value: T

if

if: create

throw

throw: create

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_finalComplete

  • _finalComplete(): void

_finalError

  • _finalError(err: any): void

  • Parameters

    • err: any

    Returns void

_finalNext

  • _finalNext(value: T): void

  • Parameters

    • value: T

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_subscribe

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

asObservable

complete

  • complete(): void

  • Returns void

error

  • error(err?: any): void

  • Parameters

    • Optional err: any

    Returns void

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

next

  • next(value: T): void

  • Parameters

    • value: T

    Returns void

remove

  • Parameters

    Returns void

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

unsubscribe

  • unsubscribe(): void

create

"node_modules/rxjs/src/BehaviorSubject"

"node_modules/rxjs/src/BehaviorSubject":

BehaviorSubject

BehaviorSubject:
class

BehaviorSubject

constructor

_isScalar

_isScalar: boolean

_value

_value: T

destination

destination: Observer<T>

dispatching

dispatching: boolean

errorValue

errorValue: any

hasCompleted

hasCompleted: boolean

hasErrored

hasErrored: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

observers

observers: Observer<T>[]

operator

operator: Operator<any, T>

source

source: Observable<T>

if

if: create

throw

throw: create

value

value:

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_finalComplete

  • _finalComplete(): void

_finalError

  • _finalError(err: any): void

  • Parameters

    • err: any

    Returns void

_finalNext

  • _finalNext(value: T): void

  • Parameters

    • value: T

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_subscribe

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

asObservable

complete

  • complete(): void

  • Returns void

error

  • error(err?: any): void

  • Parameters

    • Optional err: any

    Returns void

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

getValue

  • getValue(): T

  • Returns T

lift

next

  • next(value: T): void

  • Parameters

    • value: T

    Returns void

remove

  • Parameters

    Returns void

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

unsubscribe

  • unsubscribe(): void

create

"node_modules/rxjs/src/InnerSubscriber"

"node_modules/rxjs/src/InnerSubscriber":

InnerSubscriber

InnerSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

outerIndex

outerIndex: number

outerValue

outerValue: T

parent

parent: OuterSubscriber<T, R>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(error: any): void

  • Parameters

    • error: any

    Returns void

_next

  • _next(value: R): void

  • Parameters

    • value: R

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: R): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: R

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/MiscJSDoc"

"node_modules/rxjs/src/MiscJSDoc":

ObservableDoc

ObservableDoc:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

create

  • Creates a new Observable that will execute the specified function when a Subscriber subscribes to it.

    Creates an Observable with custom logic given in the subscribe function.

    create converts a subscribe function to an actual Observable. This is equivalent to calling the Observable constructor. Write the subscribe function so that it behaves as an Observable: It should invoke the Subscriber's next, error, and complete methods following the Observable Contract. A well-formed Observable must invoke either the Subscriber's complete method exactly once or its error method exactly once, and invoke nothing else thereafter.

    Most of the times you should not need to use create because existing creation operators (together with instance combination operators) allow you to create an Observable for most of the use cases. However, create is low-level and is able to create any Observable.

    example

    Emit three random numbers, then complete. var result = Rx.Observable.create(function (subscriber) { subscriber.next(Math.random()); subscriber.next(Math.random()); subscriber.next(Math.random()); subscriber.complete(); }); result.subscribe(x => console.log(x));

    see

    empty

    see

    never

    see

    of

    see

    throw

    static

    true

    name

    create

    owner

    Observable

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    An Observable that, when subscribed, will execute the specified function.

ObserverDoc

ObserverDoc:

An interface for a consumer of push-based notifications delivered by an Observable.

interface Observer<T> {
  isUnsubscribed?: boolean;
  next: (value: T) => void;
  error: (err: any) => void;
  complete: () => void;
}

An object conforming to the Observer interface is usually given to the observable.subscribe(observer) method, and the Observable will call the Observer's next(value) method to provide notifications. A well-behaved Observable will call an Observer's complete() method exactly once or the Observer's error(err) method exactly once, as the last notification delivered.

interface
name

Observer

noimport

true

isUnsubscribed

isUnsubscribed: boolean

An optional flag to indicate whether this Observer, when used as a subscriber, has already been unsubscribed from its Observable.

type

{boolean}

complete

  • complete(): void

  • The callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err: any): void

  • The callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • err: any

      The error exception.

    Returns void

next

  • next(value: T): void

  • The callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • value: T

      The next value.

    Returns void

SchedulerDoc

SchedulerDoc:

An execution context and a data structure to order tasks and schedule their execution. Provides a notion of (potentially virtual) time, through the now() getter method.

Each unit of work in a Scheduler is called an Action.

interface Scheduler {
  now(): number;
  schedule(work, delay?, state?): Subscription;
  flush(): void;
  active: boolean;
  actions: Action[];
  scheduledId: number;
}
interface
name

Scheduler

noimport

true

actions

actions: Action<any>[]

The queue of scheduled actions as an array.

type

{Action[]}

active

active: boolean

A flag to indicate whether the Scheduler is currently executing a batch of queued actions.

type

{boolean}

scheduledId

scheduledId: number

An internal ID used to track the latest asynchronous task such as those coming from setTimeout, setInterval, requestAnimationFrame, and others.

type

{number}

flush

  • flush(): void

  • Prompt the Scheduler to execute all of its queued actions, therefore clearing its queue.

    Returns void

now

  • now(): number

  • A getter method that returns a number representing the current time (at the time this function was called) according to the scheduler's own internal clock.

    Returns number

    A number that represents the current time. May or may not have a relation to wall-clock time. May or may not refer to a time unit (e.g. milliseconds).

schedule

  • schedule<T>(work: function, delay?: number, state?: T): Subscription

  • Schedules a function, work, for execution. May happen at some point in the future, according to the delay parameter, if specified. May be passed some context object, state, which will be passed to the work function.

    The given arguments will be processed an stored as an Action object in a queue of actions.

    Type parameters

    • T

    Parameters

    • work: function

      A function representing a task, or some unit of work to be executed by the Scheduler.

    • Optional delay: number
    • Optional state: T

    Returns Subscription

    A subscription in order to be able to unsubscribe the scheduled work.

"node_modules/rxjs/src/Notification"

"node_modules/rxjs/src/Notification":

Notification

Notification:

Represents a push-based event or value that an Observable can emit. This class is particularly useful for operators that manage notifications, like materialize, dematerialize, observeOn, and others. Besides wrapping the actual delivered value, it also annotates it with metadata of, for instance, what type of push message it is (next, error, or complete).

see

materialize

see

dematerialize

see

observeOn

class

Notification

constructor

  • new Notification(kind: string, value?: T, exception?: any): Notification

  • Parameters

    • kind: string
    • Optional value: T
    • Optional exception: any

    Returns Notification

exception

exception: any

hasValue

hasValue: boolean

kind

kind: string

value

value: T

completeNotification

completeNotification: Notification<any>

undefinedValueNotification

undefinedValueNotification: Notification<any>

accept

  • accept(nextOrObserver: PartialObserver | function, error?: function, complete?: function): any

  • Takes an Observer or its individual callback functions, and calls observe or do methods accordingly.

    Parameters

    • nextOrObserver: PartialObserver | function

      An Observer or the next callback.

    • Optional error: function
        • (err: any): void

        • Parameters

          • err: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns any

do

  • do(next: function, error?: function, complete?: function): any

  • Given some Observer callbacks, deliver the value represented by the current Notification to the correctly corresponding callback.

    Parameters

    • next: function

      An Observer next callback.

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional error: function
        • (err: any): void

        • Parameters

          • err: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns any

observe

  • Delivers to the given observer the value wrapped by this Notification.

    Parameters

    Returns any

toObservable

  • Returns a simple Observable that just delivers the notification represented by this Notification instance.

    Returns Observable<T>

createComplete

  • A shortcut to create a Notification instance of the type complete.

    Returns Notification<any>

    The valueless "complete" Notification.

createError

  • A shortcut to create a Notification instance of the type error from a given error.

    Type parameters

    • T

    Parameters

    • Optional err: any

    Returns Notification<T>

    The "error" Notification representing the argument.

createNext

  • A shortcut to create a Notification instance of the type next from a given value.

    Type parameters

    • T

    Parameters

    • value: T

      The next value.

    Returns Notification<T>

    The "next" Notification representing the argument.

"node_modules/rxjs/src/Observable"

"node_modules/rxjs/src/Observable":

Observable

Observable:

A representation of any set of values over any amount of time. This the most basic building block of RxJS.

class

Observable

constructor

  • new Observable(subscribe?: function): Observable
  • constructor

    Parameters

    • Optional subscribe: function

      the function that is called when the Observable is initially subscribed to. This function is given a Subscriber, to which new values can be nexted, or an error method can be called to raise an error, or complete can be called to notify of a successful completion.

    Returns Observable

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates a new cold Observable by calling the Observable constructor

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    a new cold observable

Subscribable

Subscribable:

subscribe

  • Parameters

    • Optional observerOrNext: PartialObserver | function
    • Optional error: function
        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns AnonymousSubscription

ObservableInput

ObservableInput: SubscribableOrPromise | ArrayLike<T>

SubscribableOrPromise

SubscribableOrPromise: Subscribable<T> | Promise<T>

"node_modules/rxjs/src/Observer"

"node_modules/rxjs/src/Observer":

CompletionObserver

CompletionObserver:

complete

complete: function

Type declaration

    • (): void

    • Returns void

error

error: function

Type declaration

    • (err: any): void

    • Parameters

      • err: any

      Returns void

isUnsubscribed

isUnsubscribed: boolean

next

next: function

Type declaration

    • (value: T): void

    • Parameters

      • value: T

      Returns void

ErrorObserver

ErrorObserver:

complete

complete: function

Type declaration

    • (): void

    • Returns void

error

error: function

Type declaration

    • (err: any): void

    • Parameters

      • err: any

      Returns void

isUnsubscribed

isUnsubscribed: boolean

next

next: function

Type declaration

    • (value: T): void

    • Parameters

      • value: T

      Returns void

NextObserver

NextObserver:

complete

complete: function

Type declaration

    • (): void

    • Returns void

error

error: function

Type declaration

    • (err: any): void

    • Parameters

      • err: any

      Returns void

isUnsubscribed

isUnsubscribed: boolean

next

next: function

Type declaration

    • (value: T): void

    • Parameters

      • value: T

      Returns void

Observer

Observer:

complete

complete: function

Type declaration

    • (): void

    • Returns void

error

error: function

Type declaration

    • (err: any): void

    • Parameters

      • err: any

      Returns void

isUnsubscribed

isUnsubscribed: boolean

next

next: function

Type declaration

    • (value: T): void

    • Parameters

      • value: T

      Returns void

PartialObserver

PartialObserver: NextObserver<T> | ErrorObserver<T> | CompletionObserver<T>

empty

empty: object

isUnsubscribed

isUnsubscribed: boolean

complete

  • complete(): void

  • Returns void

error

  • error(err: any): void

  • Parameters

    • err: any

    Returns void

next

  • next(value: any): void

  • Parameters

    • value: any

    Returns void

"node_modules/rxjs/src/Operator"

"node_modules/rxjs/src/Operator":

Operator

Operator:

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

"node_modules/rxjs/src/OuterSubscriber"

"node_modules/rxjs/src/OuterSubscriber":

OuterSubscriber

OuterSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

  • Parameters

    Returns void

notifyError

  • Parameters

    Returns void

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/ReplaySubject"

"node_modules/rxjs/src/ReplaySubject":

ReplayEvent

ReplayEvent:

constructor

  • Parameters

    • time: number
    • value: T

    Returns ReplayEvent

time

time: number

value

value: T

ReplaySubject

ReplaySubject:
class

ReplaySubject

constructor

  • Parameters

    • Default value bufferSize: number = Number.POSITIVE_INFINITY
    • Default value windowTime: number = Number.POSITIVE_INFINITY
    • Optional scheduler: Scheduler

    Returns ReplaySubject

_isScalar

_isScalar: boolean

_windowTime

_windowTime: number

bufferSize

bufferSize: number

destination

destination: Observer<T>

dispatching

dispatching: boolean

errorValue

errorValue: any

events

events: ReplayEvent<T>[]

hasCompleted

hasCompleted: boolean

hasErrored

hasErrored: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

observers

observers: Observer<T>[]

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<T>

if

if: create

throw

throw: create

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_finalComplete

  • _finalComplete(): void

_finalError

  • _finalError(err: any): void

  • Parameters

    • err: any

    Returns void

_finalNext

  • _finalNext(value: T): void

  • Parameters

    • value: T

    Returns void

_getNow

  • _getNow(): number

  • Returns number

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_subscribe

_trimBufferThenGetEvents

  • _trimBufferThenGetEvents(now: number): ReplayEvent<T>[]

  • Parameters

    • now: number

    Returns ReplayEvent<T>[]

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

asObservable

complete

  • complete(): void

  • Returns void

error

  • error(err?: any): void

  • Parameters

    • Optional err: any

    Returns void

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

next

  • next(value: T): void

  • Parameters

    • value: T

    Returns void

remove

  • Parameters

    Returns void

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

unsubscribe

  • unsubscribe(): void

create

"node_modules/rxjs/src/Rx"

"node_modules/rxjs/src/Rx":

Scheduler

Scheduler: object
typedef

{Object} Rx.Scheduler

property

{Scheduler} queue Schedules on a queue in the current event frame (trampoline scheduler). Use this for iteration operations.

property

{Scheduler} asap Schedules on the micro task queue, which uses the fastest transport mechanism available, either Node.js' process.nextTick() or Web Worker MessageChannel or setTimeout or others. Use this for asynchronous conversions.

property

{Scheduler} async Schedules work with setInterval. Use this for time-based operations.

asap

asap: AsapScheduler

async

async: AsyncScheduler

queue

queue: QueueScheduler

Symbol

Symbol: object
typedef

{Object} Rx.Symbol

property

{Symbol|string} rxSubscriber A symbol to use as a property name to retrieve an "Rx safe" Observer from an object. "Rx safety" can be defined as an object that has all of the traits of an Rx Subscriber, including the ability to add and remove subscriptions to the subscription chain and guarantees involving event triggering (can't "next" after unsubscription, etc).

property

{Symbol|string} observable A symbol to use as a property name to retrieve an Observable as defined by the ECMAScript "Observable" spec.

property

{Symbol|string} iterator The ES6 symbol to use as a property name to retrieve an iterator from an object.

iterator

iterator: any

observable

observable: symbol

rxSubscriber

rxSubscriber: any

"node_modules/rxjs/src/Rx.DOM"

"node_modules/rxjs/src/Rx.DOM":

Scheduler

Scheduler: object

animationFrame

animationFrame: AnimationFrameScheduler

asap

asap: AsapScheduler

async

async: AsyncScheduler

queue

queue: QueueScheduler

"node_modules/rxjs/src/Rx.KitchenSink"

"node_modules/rxjs/src/Rx.KitchenSink":

"node_modules/rxjs/src/Scheduler"

"node_modules/rxjs/src/Scheduler":

Scheduler

Scheduler:

actions

actions: Action<any>[]

active

active: boolean

scheduledId

scheduledId: number

flush

  • flush(): void

  • Returns void

now

  • now(): number

  • Returns number

schedule

  • schedule<T>(work: function, delay?: number, state?: T): Subscription

  • Type parameters

    • T

    Parameters

    • work: function
    • Optional delay: number
    • Optional state: T

    Returns Subscription

"node_modules/rxjs/src/Subject"

"node_modules/rxjs/src/Subject":

Subject

Subject:
class

Subject

constructor

_isScalar

_isScalar: boolean

destination

destination: Observer<T>

dispatching

dispatching: boolean

errorValue

errorValue: any

hasCompleted

hasCompleted: boolean

hasErrored

hasErrored: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

observers

observers: Observer<T>[]

operator

operator: Operator<any, T>

source

source: Observable<T>

if

if: create

throw

throw: create

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_finalComplete

  • _finalComplete(): void

  • Returns void

_finalError

  • _finalError(err: any): void

  • Parameters

    • err: any

    Returns void

_finalNext

  • _finalNext(value: T): void

  • Parameters

    • value: T

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_subscribe

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

asObservable

  • Returns Observable<T>

complete

  • complete(): void

  • Returns void

error

  • error(err?: any): void

  • Parameters

    • Optional err: any

    Returns void

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

next

  • next(value: T): void

  • Parameters

    • value: T

    Returns void

remove

  • Parameters

    Returns void

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

throwIfUnsubscribed

  • throwIfUnsubscribed(): void

  • Returns void

unsubscribe

  • unsubscribe(): void

create

SubjectObservable

SubjectObservable:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates a new cold Observable by calling the Observable constructor

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    a new cold observable

"node_modules/rxjs/src/SubjectSubscription"

"node_modules/rxjs/src/SubjectSubscription":

SubjectSubscription

SubjectSubscription:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

isUnsubscribed

isUnsubscribed: boolean

observer

observer: Observer<any>

subject

subject: Subject<any>

EMPTY

EMPTY: Subscription

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

"node_modules/rxjs/src/Subscriber"

"node_modules/rxjs/src/Subscriber":

SafeSubscriber

SafeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • _parent: Subscriber<T>
    • Optional observerOrNext: PartialObserver | function
    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns SafeSubscriber

_context

_context: any

_parent

_parent: Subscriber<T>

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

___tryOrSetError

  • ___tryOrSetError(parent: Subscriber<T>, fn: Function, value?: any): boolean

  • Parameters

    • parent: Subscriber<T>
    • fn: Function
    • Optional value: any

    Returns boolean

___tryOrUnsub

  • ___tryOrUnsub(fn: Function, value?: any): void

  • Parameters

    • fn: Function
    • Optional value: any

    Returns void

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • Returns void

error

  • error(err?: any): void

  • Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

Subscriber

Subscriber:

Implements the Observer interface and extends the Subscription class. While the Observer is the public API for consuming the values of an Observable, all Observers get converted to a Subscriber, in order to provide Subscription-like capabilities such as unsubscribe. Subscriber is a common type in RxJS, and crucial for implementing operators, but it is rarely used as a public API.

class

Subscriber

constructor

  • Parameters

    • Optional destinationOrNext: PartialObserver | function
    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

  • Returns Subscriber<T>

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/Subscription"

"node_modules/rxjs/src/Subscription":

Subscription

Subscription:

Represents a disposable resource, such as the execution of an Observable. A Subscription has one important method, unsubscribe, that takes no argument and just disposes the resource held by the subscription.

Additionally, subscriptions may be grouped together through the add() method, which will attach a child Subscription to the current Subscription. When a Subscription is unsubscribed, all its children (and its grandchildren) will be unsubscribed as well.

class

Subscription

constructor

  • Parameters

    • Optional unsubscribe: function
        • (): void

        • Returns void

    Returns Subscription

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

EMPTY

EMPTY: Subscription

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

  • Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

    Returns void

AnonymousSubscription

AnonymousSubscription:

unsubscribe

  • unsubscribe(): void

  • Returns void

ISubscription

ISubscription:

isUnsubscribed

isUnsubscribed: boolean

add

remove

  • Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

TeardownLogic

TeardownLogic: AnonymousSubscription | Function | void

"node_modules/rxjs/src/add/observable/bindCallback"

"node_modules/rxjs/src/add/observable/bindCallback":

"../../Observable"

"../../Observable":

Observable

Observable:

bindCallback

bindCallback: create

"node_modules/rxjs/src/add/observable/bindNodeCallback"

"node_modules/rxjs/src/add/observable/bindNodeCallback":

"../../Observable"

"../../Observable":

Observable

Observable:

bindNodeCallback

bindNodeCallback: create

"node_modules/rxjs/src/add/observable/combineLatest"

"node_modules/rxjs/src/add/observable/combineLatest":

"../../Observable"

"../../Observable":

Observable

Observable:

combineLatest

combineLatest: combineLatestStatic

"node_modules/rxjs/src/add/observable/concat"

"node_modules/rxjs/src/add/observable/concat":

"../../Observable"

"../../Observable":

Observable

Observable:

concat

concat: concatStatic

"node_modules/rxjs/src/add/observable/defer"

"node_modules/rxjs/src/add/observable/defer":

"../../Observable"

"../../Observable":

Observable

Observable:

defer

defer: create

"node_modules/rxjs/src/add/observable/dom/ajax"

"node_modules/rxjs/src/add/observable/dom/ajax":

"../../../Observable"

"../../../Observable":

Observable

Observable:

ajax

ajax: AjaxCreationMethod

"node_modules/rxjs/src/add/observable/dom/webSocket"

"node_modules/rxjs/src/add/observable/dom/webSocket":

"../../../Observable"

"../../../Observable":

Observable

Observable:

webSocket

webSocket: create

"node_modules/rxjs/src/add/observable/empty"

"node_modules/rxjs/src/add/observable/empty":

"../../Observable"

"../../Observable":

Observable

Observable:

empty

empty: create

"node_modules/rxjs/src/add/observable/forkJoin"

"node_modules/rxjs/src/add/observable/forkJoin":

"../../Observable"

"../../Observable":

Observable

Observable:

forkJoin

forkJoin: create

"node_modules/rxjs/src/add/observable/from"

"node_modules/rxjs/src/add/observable/from":

"../../Observable"

"../../Observable":

Observable

Observable:

from

from: create

"node_modules/rxjs/src/add/observable/fromEvent"

"node_modules/rxjs/src/add/observable/fromEvent":

"../../Observable"

"../../Observable":

Observable

Observable:

fromEvent

fromEvent: create

"node_modules/rxjs/src/add/observable/fromEventPattern"

"node_modules/rxjs/src/add/observable/fromEventPattern":

"../../Observable"

"../../Observable":

Observable

Observable:

fromEventPattern

fromEventPattern: create

"node_modules/rxjs/src/add/observable/fromPromise"

"node_modules/rxjs/src/add/observable/fromPromise":

"../../Observable"

"../../Observable":

Observable

Observable:

fromPromise

fromPromise: create

"node_modules/rxjs/src/add/observable/if"

"node_modules/rxjs/src/add/observable/if":

"node_modules/rxjs/src/add/observable/interval"

"node_modules/rxjs/src/add/observable/interval":

"../../Observable"

"../../Observable":

Observable

Observable:

interval

interval: create

"node_modules/rxjs/src/add/observable/merge"

"node_modules/rxjs/src/add/observable/merge":

"../../Observable"

"../../Observable":

Observable

Observable:

merge

merge: mergeStatic

"node_modules/rxjs/src/add/observable/never"

"node_modules/rxjs/src/add/observable/never":

"../../Observable"

"../../Observable":

Observable

Observable:

never

never: create

"node_modules/rxjs/src/add/observable/of"

"node_modules/rxjs/src/add/observable/of":

"../../Observable"

"../../Observable":

Observable

Observable:

of

of: of

"node_modules/rxjs/src/add/observable/race"

"node_modules/rxjs/src/add/observable/race":

"../../Observable"

"../../Observable":

Observable

Observable:

race

race: raceStatic

"node_modules/rxjs/src/add/observable/range"

"node_modules/rxjs/src/add/observable/range":

"../../Observable"

"../../Observable":

Observable

Observable:

range

range: create

"node_modules/rxjs/src/add/observable/throw"

"node_modules/rxjs/src/add/observable/throw":

"node_modules/rxjs/src/add/observable/timer"

"node_modules/rxjs/src/add/observable/timer":

"../../Observable"

"../../Observable":

Observable

Observable:

timer

timer: create

"node_modules/rxjs/src/add/observable/using"

"node_modules/rxjs/src/add/observable/using":

"../../Observable"

"../../Observable":

Observable

Observable:

using

using: create

"node_modules/rxjs/src/add/observable/zip"

"node_modules/rxjs/src/add/observable/zip":

"../../Observable"

"../../Observable":

Observable

Observable:

zip

zip: zipStatic

"node_modules/rxjs/src/add/operator/audit"

"node_modules/rxjs/src/add/operator/audit":

"../../Observable"

"../../Observable":

Observable

Observable:

audit

audit: AuditSignature<T>

"node_modules/rxjs/src/add/operator/auditTime"

"node_modules/rxjs/src/add/operator/auditTime":

"../../Observable"

"../../Observable":

Observable

Observable:

auditTime

auditTime: AuditTimeSignature<T>

"node_modules/rxjs/src/add/operator/buffer"

"node_modules/rxjs/src/add/operator/buffer":

"../../Observable"

"../../Observable":

Observable

Observable:

buffer

buffer: BufferSignature<T>

"node_modules/rxjs/src/add/operator/bufferCount"

"node_modules/rxjs/src/add/operator/bufferCount":

"../../Observable"

"../../Observable":

Observable

Observable:

bufferCount

bufferCount: BufferCountSignature<T>

"node_modules/rxjs/src/add/operator/bufferTime"

"node_modules/rxjs/src/add/operator/bufferTime":

"../../Observable"

"../../Observable":

Observable

Observable:

bufferTime

bufferTime: BufferTimeSignature<T>

"node_modules/rxjs/src/add/operator/bufferToggle"

"node_modules/rxjs/src/add/operator/bufferToggle":

"../../Observable"

"../../Observable":

Observable

Observable:

bufferToggle

bufferToggle: BufferToggleSignature<T>

"node_modules/rxjs/src/add/operator/bufferWhen"

"node_modules/rxjs/src/add/operator/bufferWhen":

"../../Observable"

"../../Observable":

Observable

Observable:

bufferWhen

bufferWhen: BufferWhenSignature<T>

"node_modules/rxjs/src/add/operator/cache"

"node_modules/rxjs/src/add/operator/cache":

"../../Observable"

"../../Observable":

Observable

Observable:

cache

cache: CacheSignature<T>

"node_modules/rxjs/src/add/operator/catch"

"node_modules/rxjs/src/add/operator/catch":

"../../Observable"

"../../Observable":

Observable

Observable:

catch

catch: CatchSignature<T>

"node_modules/rxjs/src/add/operator/combineAll"

"node_modules/rxjs/src/add/operator/combineAll":

"../../Observable"

"../../Observable":

Observable

Observable:

combineAll

combineAll: CombineAllSignature<T>

"node_modules/rxjs/src/add/operator/combineLatest"

"node_modules/rxjs/src/add/operator/combineLatest":

"../../Observable"

"../../Observable":

Observable

Observable:

combineLatest

combineLatest: CombineLatestSignature<T>

"node_modules/rxjs/src/add/operator/concat"

"node_modules/rxjs/src/add/operator/concat":

"../../Observable"

"../../Observable":

Observable

Observable:

concat

concat: ConcatSignature<T>

"node_modules/rxjs/src/add/operator/concatAll"

"node_modules/rxjs/src/add/operator/concatAll":

"../../Observable"

"../../Observable":

Observable

Observable:

concatAll

concatAll: ConcatAllSignature<T>

"node_modules/rxjs/src/add/operator/concatMap"

"node_modules/rxjs/src/add/operator/concatMap":

"../../Observable"

"../../Observable":

Observable

Observable:

concatMap

concatMap: ConcatMapSignature<T>

"node_modules/rxjs/src/add/operator/concatMapTo"

"node_modules/rxjs/src/add/operator/concatMapTo":

"../../Observable"

"../../Observable":

Observable

Observable:

concatMapTo

concatMapTo: ConcatMapToSignature<T>

"node_modules/rxjs/src/add/operator/count"

"node_modules/rxjs/src/add/operator/count":

"../../Observable"

"../../Observable":

Observable

Observable:

count

count: CountSignature<T>

"node_modules/rxjs/src/add/operator/debounce"

"node_modules/rxjs/src/add/operator/debounce":

"../../Observable"

"../../Observable":

Observable

Observable:

debounce

debounce: DebounceSignature<T>

"node_modules/rxjs/src/add/operator/debounceTime"

"node_modules/rxjs/src/add/operator/debounceTime":

"../../Observable"

"../../Observable":

Observable

Observable:

debounceTime

debounceTime: DebounceTimeSignature<T>

"node_modules/rxjs/src/add/operator/defaultIfEmpty"

"node_modules/rxjs/src/add/operator/defaultIfEmpty":

"../../Observable"

"../../Observable":

Observable

Observable:

defaultIfEmpty

defaultIfEmpty: DefaultIfEmptySignature<T>

"node_modules/rxjs/src/add/operator/delay"

"node_modules/rxjs/src/add/operator/delay":

"../../Observable"

"../../Observable":

Observable

Observable:

delay

delay: DelaySignature<T>

"node_modules/rxjs/src/add/operator/delayWhen"

"node_modules/rxjs/src/add/operator/delayWhen":

"../../Observable"

"../../Observable":

Observable

Observable:

delayWhen

delayWhen: DelayWhenSignature<T>

"node_modules/rxjs/src/add/operator/dematerialize"

"node_modules/rxjs/src/add/operator/dematerialize":

"../../Observable"

"../../Observable":

Observable

Observable:

dematerialize

dematerialize: DematerializeSignature<T>

"node_modules/rxjs/src/add/operator/distinct"

"node_modules/rxjs/src/add/operator/distinct":

"../../Observable"

"../../Observable":

Observable

Observable:

distinct

distinct: DistinctSignature<T>

"node_modules/rxjs/src/add/operator/distinctKey"

"node_modules/rxjs/src/add/operator/distinctKey":

"../../Observable"

"../../Observable":

Observable

Observable:

distinctKey

distinctKey: DistinctKeySignature<T>

"node_modules/rxjs/src/add/operator/distinctUntilChanged"

"node_modules/rxjs/src/add/operator/distinctUntilChanged":

"../../Observable"

"../../Observable":

Observable

Observable:

distinctUntilChanged

distinctUntilChanged: DistinctUntilChangedSignature<T>

"node_modules/rxjs/src/add/operator/distinctUntilKeyChanged"

"node_modules/rxjs/src/add/operator/distinctUntilKeyChanged":

"../../Observable"

"../../Observable":

Observable

Observable:

distinctUntilKeyChanged

distinctUntilKeyChanged: DistinctUntilKeyChangedSignature<T>

"node_modules/rxjs/src/add/operator/do"

"node_modules/rxjs/src/add/operator/do":

"../../Observable"

"../../Observable":

Observable

Observable:

do

do: DoSignature<T>

"node_modules/rxjs/src/add/operator/elementAt"

"node_modules/rxjs/src/add/operator/elementAt":

"../../Observable"

"../../Observable":

Observable

Observable:

elementAt

elementAt: ElementAtSignature<T>

"node_modules/rxjs/src/add/operator/every"

"node_modules/rxjs/src/add/operator/every":

"../../Observable"

"../../Observable":

Observable

Observable:

every

every: EverySignature<T>

"node_modules/rxjs/src/add/operator/exhaust"

"node_modules/rxjs/src/add/operator/exhaust":

"../../Observable"

"../../Observable":

Observable

Observable:

exhaust

exhaust: SwitchFirstSignature<T>

"node_modules/rxjs/src/add/operator/exhaustMap"

"node_modules/rxjs/src/add/operator/exhaustMap":

"../../Observable"

"../../Observable":

Observable

Observable:

exhaustMap

exhaustMap: SwitchFirstMapSignature<T>

"node_modules/rxjs/src/add/operator/expand"

"node_modules/rxjs/src/add/operator/expand":

"../../Observable"

"../../Observable":

Observable

Observable:

expand

expand: ExpandSignature<T>

"node_modules/rxjs/src/add/operator/filter"

"node_modules/rxjs/src/add/operator/filter":

"../../Observable"

"../../Observable":

Observable

Observable:

filter

filter: FilterSignature<T>

"node_modules/rxjs/src/add/operator/finally"

"node_modules/rxjs/src/add/operator/finally":

"../../Observable"

"../../Observable":

Observable

Observable:

finally

finally: FinallySignature<T>

"node_modules/rxjs/src/add/operator/find"

"node_modules/rxjs/src/add/operator/find":

"../../Observable"

"../../Observable":

Observable

Observable:

find

find: FindSignature<T>

"node_modules/rxjs/src/add/operator/findIndex"

"node_modules/rxjs/src/add/operator/findIndex":

"../../Observable"

"../../Observable":

Observable

Observable:

findIndex

findIndex: FindIndexSignature<T>

"node_modules/rxjs/src/add/operator/first"

"node_modules/rxjs/src/add/operator/first":

"../../Observable"

"../../Observable":

Observable

Observable:

first

first: FirstSignature<T>

"node_modules/rxjs/src/add/operator/groupBy"

"node_modules/rxjs/src/add/operator/groupBy":

"../../Observable"

"../../Observable":

Observable

Observable:

groupBy

groupBy: GroupBySignature<T>

"node_modules/rxjs/src/add/operator/ignoreElements"

"node_modules/rxjs/src/add/operator/ignoreElements":

"../../Observable"

"../../Observable":

Observable

Observable:

ignoreElements

ignoreElements: IgnoreElementsSignature<T>

"node_modules/rxjs/src/add/operator/isEmpty"

"node_modules/rxjs/src/add/operator/isEmpty":

"../../Observable"

"../../Observable":

Observable

Observable:

isEmpty

isEmpty: IsEmptySignature<T>

"node_modules/rxjs/src/add/operator/last"

"node_modules/rxjs/src/add/operator/last":

"../../Observable"

"../../Observable":

Observable

Observable:

last

last: LastSignature<T>

"node_modules/rxjs/src/add/operator/let"

"node_modules/rxjs/src/add/operator/let":

"../../Observable"

"../../Observable":

Observable

Observable:

let

let: LetSignature<T>

letBind

letBind: LetSignature<T>

"node_modules/rxjs/src/add/operator/map"

"node_modules/rxjs/src/add/operator/map":

"../../Observable"

"../../Observable":

Observable

Observable:

map

map: MapSignature<T>

"node_modules/rxjs/src/add/operator/mapTo"

"node_modules/rxjs/src/add/operator/mapTo":

"../../Observable"

"../../Observable":

Observable

Observable:

mapTo

mapTo: MapToSignature<T>

"node_modules/rxjs/src/add/operator/materialize"

"node_modules/rxjs/src/add/operator/materialize":

"../../Observable"

"../../Observable":

Observable

Observable:

materialize

materialize: MaterializeSignature<T>

"node_modules/rxjs/src/add/operator/max"

"node_modules/rxjs/src/add/operator/max":

"../../Observable"

"../../Observable":

Observable

Observable:

max

max: MaxSignature<T>

"node_modules/rxjs/src/add/operator/merge"

"node_modules/rxjs/src/add/operator/merge":

"../../Observable"

"../../Observable":

Observable

Observable:

merge

merge: MergeSignature<T>

"node_modules/rxjs/src/add/operator/mergeAll"

"node_modules/rxjs/src/add/operator/mergeAll":

"../../Observable"

"../../Observable":

Observable

Observable:

mergeAll

mergeAll: MergeAllSignature<T>

"node_modules/rxjs/src/add/operator/mergeMap"

"node_modules/rxjs/src/add/operator/mergeMap":

"../../Observable"

"../../Observable":

Observable

Observable:

flatMap

flatMap: MergeMapSignature<T>

mergeMap

mergeMap: MergeMapSignature<T>

"node_modules/rxjs/src/add/operator/mergeMapTo"

"node_modules/rxjs/src/add/operator/mergeMapTo":

"../../Observable"

"../../Observable":

Observable

Observable:

flatMapTo

flatMapTo: MergeMapToSignature<T>

mergeMapTo

mergeMapTo: MergeMapToSignature<T>

"node_modules/rxjs/src/add/operator/mergeScan"

"node_modules/rxjs/src/add/operator/mergeScan":

"../../Observable"

"../../Observable":

Observable

Observable:

mergeScan

mergeScan: MergeScanSignature<T>

"node_modules/rxjs/src/add/operator/min"

"node_modules/rxjs/src/add/operator/min":

"../../Observable"

"../../Observable":

Observable

Observable:

min

min: MinSignature<T>

"node_modules/rxjs/src/add/operator/multicast"

"node_modules/rxjs/src/add/operator/multicast":

"../../Observable"

"../../Observable":

Observable

Observable:

multicast

multicast: MulticastSignature<T>

"node_modules/rxjs/src/add/operator/observeOn"

"node_modules/rxjs/src/add/operator/observeOn":

"../../Observable"

"../../Observable":

Observable

Observable:

observeOn

observeOn: ObserveOnSignature<T>

"node_modules/rxjs/src/add/operator/pairwise"

"node_modules/rxjs/src/add/operator/pairwise":

"../../Observable"

"../../Observable":

Observable

Observable:

pairwise

pairwise: PairwiseSignature<T>

"node_modules/rxjs/src/add/operator/partition"

"node_modules/rxjs/src/add/operator/partition":

"../../Observable"

"../../Observable":

Observable

Observable:

partition

partition: PartitionSignature<T>

"node_modules/rxjs/src/add/operator/pluck"

"node_modules/rxjs/src/add/operator/pluck":

"../../Observable"

"../../Observable":

Observable

Observable:

pluck

pluck: PluckSignature<T>

"node_modules/rxjs/src/add/operator/publish"

"node_modules/rxjs/src/add/operator/publish":

"../../Observable"

"../../Observable":

Observable

Observable:

publish

publish: PublishSignature<T>

"node_modules/rxjs/src/add/operator/publishBehavior"

"node_modules/rxjs/src/add/operator/publishBehavior":

"../../Observable"

"../../Observable":

Observable

Observable:

publishBehavior

publishBehavior: PublishBehaviorSignature<T>

"node_modules/rxjs/src/add/operator/publishLast"

"node_modules/rxjs/src/add/operator/publishLast":

"../../Observable"

"../../Observable":

Observable

Observable:

publishLast

publishLast: PublishLastSignature<T>

"node_modules/rxjs/src/add/operator/publishReplay"

"node_modules/rxjs/src/add/operator/publishReplay":

"../../Observable"

"../../Observable":

Observable

Observable:

publishReplay

publishReplay: PublishReplaySignature<T>

"node_modules/rxjs/src/add/operator/race"

"node_modules/rxjs/src/add/operator/race":

"../../Observable"

"../../Observable":

Observable

Observable:

race

race: RaceSignature<T>

"node_modules/rxjs/src/add/operator/reduce"

"node_modules/rxjs/src/add/operator/reduce":

"../../Observable"

"../../Observable":

Observable

Observable:

reduce

reduce: ReduceSignature<T>

"node_modules/rxjs/src/add/operator/repeat"

"node_modules/rxjs/src/add/operator/repeat":

"../../Observable"

"../../Observable":

Observable

Observable:

repeat

repeat: RepeatSignature<T>

"node_modules/rxjs/src/add/operator/retry"

"node_modules/rxjs/src/add/operator/retry":

"../../Observable"

"../../Observable":

Observable

Observable:

retry

retry: RetrySignature<T>

"node_modules/rxjs/src/add/operator/retryWhen"

"node_modules/rxjs/src/add/operator/retryWhen":

"../../Observable"

"../../Observable":

Observable

Observable:

retryWhen

retryWhen: RetryWhenSignature<T>

"node_modules/rxjs/src/add/operator/sample"

"node_modules/rxjs/src/add/operator/sample":

"../../Observable"

"../../Observable":

Observable

Observable:

sample

sample: SampleSignature<T>

"node_modules/rxjs/src/add/operator/sampleTime"

"node_modules/rxjs/src/add/operator/sampleTime":

"../../Observable"

"../../Observable":

Observable

Observable:

sampleTime

sampleTime: SampleTimeSignature<T>

"node_modules/rxjs/src/add/operator/scan"

"node_modules/rxjs/src/add/operator/scan":

"../../Observable"

"../../Observable":

Observable

Observable:

scan

scan: ScanSignature<T>

"node_modules/rxjs/src/add/operator/share"

"node_modules/rxjs/src/add/operator/share":

"../../Observable"

"../../Observable":

Observable

Observable:

share

share: ShareSignature<T>

"node_modules/rxjs/src/add/operator/single"

"node_modules/rxjs/src/add/operator/single":

"../../Observable"

"../../Observable":

Observable

Observable:

single

single: SingleSignature<T>

"node_modules/rxjs/src/add/operator/skip"

"node_modules/rxjs/src/add/operator/skip":

"../../Observable"

"../../Observable":

Observable

Observable:

skip

skip: SkipSignature<T>

"node_modules/rxjs/src/add/operator/skipUntil"

"node_modules/rxjs/src/add/operator/skipUntil":

"../../Observable"

"../../Observable":

Observable

Observable:

skipUntil

skipUntil: SkipUntilSignature<T>

"node_modules/rxjs/src/add/operator/skipWhile"

"node_modules/rxjs/src/add/operator/skipWhile":

"../../Observable"

"../../Observable":

Observable

Observable:

skipWhile

skipWhile: SkipWhileSignature<T>

"node_modules/rxjs/src/add/operator/startWith"

"node_modules/rxjs/src/add/operator/startWith":

"../../Observable"

"../../Observable":

Observable

Observable:

startWith

startWith: StartWithSignature<T>

"node_modules/rxjs/src/add/operator/subscribeOn"

"node_modules/rxjs/src/add/operator/subscribeOn":

"../../Observable"

"../../Observable":

Observable

Observable:

subscribeOn

subscribeOn: SubscribeOnSignature<T>

"node_modules/rxjs/src/add/operator/switch"

"node_modules/rxjs/src/add/operator/switch":

"../../Observable"

"../../Observable":

Observable

Observable:

switch

switch: SwitchSignature<T>

"node_modules/rxjs/src/add/operator/switchMap"

"node_modules/rxjs/src/add/operator/switchMap":

"../../Observable"

"../../Observable":

Observable

Observable:

switchMap

switchMap: SwitchMapSignature<T>

"node_modules/rxjs/src/add/operator/switchMapTo"

"node_modules/rxjs/src/add/operator/switchMapTo":

"../../Observable"

"../../Observable":

Observable

Observable:

switchMapTo

switchMapTo: SwitchMapToSignature<T>

"node_modules/rxjs/src/add/operator/take"

"node_modules/rxjs/src/add/operator/take":

"../../Observable"

"../../Observable":

Observable

Observable:

take

take: TakeSignature<T>

"node_modules/rxjs/src/add/operator/takeLast"

"node_modules/rxjs/src/add/operator/takeLast":

"../../Observable"

"../../Observable":

Observable

Observable:

takeLast

takeLast: TakeLastSignature<T>

"node_modules/rxjs/src/add/operator/takeUntil"

"node_modules/rxjs/src/add/operator/takeUntil":

"../../Observable"

"../../Observable":

Observable

Observable:

takeUntil

takeUntil: TakeUntilSignature<T>

"node_modules/rxjs/src/add/operator/takeWhile"

"node_modules/rxjs/src/add/operator/takeWhile":

"../../Observable"

"../../Observable":

Observable

Observable:

takeWhile

takeWhile: TakeWhileSignature<T>

"node_modules/rxjs/src/add/operator/throttle"

"node_modules/rxjs/src/add/operator/throttle":

"../../Observable"

"../../Observable":

Observable

Observable:

throttle

throttle: ThrottleSignature<T>

"node_modules/rxjs/src/add/operator/throttleTime"

"node_modules/rxjs/src/add/operator/throttleTime":

"../../Observable"

"../../Observable":

Observable

Observable:

throttleTime

throttleTime: ThrottleTimeSignature<T>

"node_modules/rxjs/src/add/operator/timeInterval"

"node_modules/rxjs/src/add/operator/timeInterval":

"../../Observable"

"../../Observable":

Observable

Observable:

timeInterval

timeInterval: TimeIntervalSignature<T>

"node_modules/rxjs/src/add/operator/timeout"

"node_modules/rxjs/src/add/operator/timeout":

"../../Observable"

"../../Observable":

Observable

Observable:

timeout

timeout: TimeoutSignature<T>

"node_modules/rxjs/src/add/operator/timeoutWith"

"node_modules/rxjs/src/add/operator/timeoutWith":

"../../Observable"

"../../Observable":

Observable

Observable:

timeoutWith

timeoutWith: TimeoutWithSignature<T>

"node_modules/rxjs/src/add/operator/timestamp"

"node_modules/rxjs/src/add/operator/timestamp":

"../../Observable"

"../../Observable":

Observable

Observable:

timestamp

timestamp: TimestampSignature<T>

"node_modules/rxjs/src/add/operator/toArray"

"node_modules/rxjs/src/add/operator/toArray":

"../../Observable"

"../../Observable":

Observable

Observable:

toArray

toArray: ToArraySignature<T>

"node_modules/rxjs/src/add/operator/toPromise"

"node_modules/rxjs/src/add/operator/toPromise":

"../../Observable"

"../../Observable":

Observable

Observable:

toPromise

toPromise: ToPromiseSignature<T>

"node_modules/rxjs/src/add/operator/window"

"node_modules/rxjs/src/add/operator/window":

"../../Observable"

"../../Observable":

Observable

Observable:

window

window: WindowSignature<T>

"node_modules/rxjs/src/add/operator/windowCount"

"node_modules/rxjs/src/add/operator/windowCount":

"../../Observable"

"../../Observable":

Observable

Observable:

windowCount

windowCount: WindowCountSignature<T>

"node_modules/rxjs/src/add/operator/windowTime"

"node_modules/rxjs/src/add/operator/windowTime":

"../../Observable"

"../../Observable":

Observable

Observable:

windowTime

windowTime: WindowTimeSignature<T>

"node_modules/rxjs/src/add/operator/windowToggle"

"node_modules/rxjs/src/add/operator/windowToggle":

"../../Observable"

"../../Observable":

Observable

Observable:

windowToggle

windowToggle: WindowToggleSignature<T>

"node_modules/rxjs/src/add/operator/windowWhen"

"node_modules/rxjs/src/add/operator/windowWhen":

"../../Observable"

"../../Observable":

Observable

Observable:

windowWhen

windowWhen: WindowWhenSignature<T>

"node_modules/rxjs/src/add/operator/withLatestFrom"

"node_modules/rxjs/src/add/operator/withLatestFrom":

"../../Observable"

"../../Observable":

Observable

Observable:

withLatestFrom

withLatestFrom: WithLatestFromSignature<T>

"node_modules/rxjs/src/add/operator/zip"

"node_modules/rxjs/src/add/operator/zip":

"../../Observable"

"../../Observable":

Observable

Observable:

zip

zip: ZipSignature<T>

"node_modules/rxjs/src/add/operator/zipAll"

"node_modules/rxjs/src/add/operator/zipAll":

"../../Observable"

"../../Observable":

Observable

Observable:

zipAll

zipAll: ZipAllSignature<T>

"node_modules/rxjs/src/observable/ArrayLikeObservable"

"node_modules/rxjs/src/observable/ArrayLikeObservable":

ArrayLikeObservable

ArrayLikeObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

  • Parameters

    • arrayLike: ArrayLike<T>
    • mapFn: function
        • (x: T, y: number): T

        • Parameters

          • x: T
          • y: number

          Returns T

    • thisArg: any
    • Optional scheduler: Scheduler

    Returns ArrayLikeObservable

_isScalar

_isScalar: boolean

arrayLike

arrayLike: ArrayLike<T>

mapFn

mapFn: function

Type declaration

    • (x: T, y: number): T

    • Parameters

      • x: T
      • y: number

      Returns T

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

value

value: any

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • create<T>(arrayLike: ArrayLike<T>, mapFn: function, thisArg: any, scheduler?: Scheduler): Observable<T>

  • Type parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>
    • mapFn: function
        • (x: T, y: number): T

        • Parameters

          • x: T
          • y: number

          Returns T

    • thisArg: any
    • Optional scheduler: Scheduler

    Returns Observable<T>

dispatch

  • dispatch(state: any): void

  • Parameters

    • state: any

    Returns void

"node_modules/rxjs/src/observable/ArrayObservable"

"node_modules/rxjs/src/observable/ArrayObservable":

ArrayObservable

ArrayObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

array

array: T[]

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

value

value: any

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Type parameters

    • T

    Parameters

    Returns Observable<T>

dispatch

  • dispatch(state: any): void

  • Parameters

    • state: any

    Returns void

of

  • Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

    Emits the arguments you provide, then completes.

    This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    An Observable that emits each given input value.

  • Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

    Emits the arguments you provide, then completes.

    This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

    Type parameters

    • T

    Parameters

    • item1: T
    • item2: T
    • Optional scheduler: Scheduler

    Returns Observable<T>

    An Observable that emits each given input value.

  • Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

    Emits the arguments you provide, then completes.

    This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

    Type parameters

    • T

    Parameters

    • item1: T
    • item2: T
    • item3: T
    • Optional scheduler: Scheduler

    Returns Observable<T>

    An Observable that emits each given input value.

  • Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

    Emits the arguments you provide, then completes.

    This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

    Type parameters

    • T

    Parameters

    • item1: T
    • item2: T
    • item3: T
    • item4: T
    • Optional scheduler: Scheduler

    Returns Observable<T>

    An Observable that emits each given input value.

  • Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

    Emits the arguments you provide, then completes.

    This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

    Type parameters

    • T

    Parameters

    • item1: T
    • item2: T
    • item3: T
    • item4: T
    • item5: T
    • Optional scheduler: Scheduler

    Returns Observable<T>

    An Observable that emits each given input value.

  • Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

    Emits the arguments you provide, then completes.

    This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

    Type parameters

    • T

    Parameters

    • item1: T
    • item2: T
    • item3: T
    • item4: T
    • item5: T
    • item6: T
    • Optional scheduler: Scheduler

    Returns Observable<T>

    An Observable that emits each given input value.

  • Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

    Emits the arguments you provide, then completes.

    This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    An Observable that emits each given input value.

"node_modules/rxjs/src/observable/BoundCallbackObservable"

"node_modules/rxjs/src/observable/BoundCallbackObservable":

BoundCallbackObservable

BoundCallbackObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

args

args: any[]

callbackFunc

callbackFunc: Function

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

selector

selector: Function

source

source: Observable<any>

subject

subject: AsyncSubject<T>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • create<R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T, T2, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T, T2, T3, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T, T2, T3, T4, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T, T2, T3, T4, T5, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T, T2, T3, T4, T5, T6, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
  • create<T, R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
  • create<T, T2, R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
  • create<T, T2, T3, R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
  • create<T, T2, T3, T4, R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
  • create<T, T2, T3, T4, T5, R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
  • create<T, T2, T3, T4, T5, T6, R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
  • create<T>(callbackFunc: Function, selector?: void, scheduler?: Scheduler): function
  • create<T>(callbackFunc: Function, selector?: function, scheduler?: Scheduler): function

  • Converts a callback function to an observable sequence.

    Type parameters

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (callback: function): any

        • Parameters

          • callback: function
              • (result: R): any

              • Parameters

                • result: R

                Returns any

          Returns any

    • Optional selector: void

      A selector which takes the arguments from the callback to produce a single item to yield on next.

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (v1: T, callback: function): any

        • Parameters

          • v1: T
          • callback: function
              • (result: R): any

              • Parameters

                • result: R

                Returns any

          Returns any

    • Optional selector: void

      A selector which takes the arguments from the callback to produce a single item to yield on next.

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    • T2

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (v1: T, v2: T2, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • callback: function
              • (result: R): any

              • Parameters

                • result: R

                Returns any

          Returns any

    • Optional selector: void

      A selector which takes the arguments from the callback to produce a single item to yield on next.

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    • T2

    • T3

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (v1: T, v2: T2, v3: T3, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • v3: T3
          • callback: function
              • (result: R): any

              • Parameters

                • result: R

                Returns any

          Returns any

    • Optional selector: void

      A selector which takes the arguments from the callback to produce a single item to yield on next.

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (v1: T, v2: T2, v3: T3, v4: T4, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • v3: T3
          • v4: T4
          • callback: function
              • (result: R): any

              • Parameters

                • result: R

                Returns any

          Returns any

    • Optional selector: void

      A selector which takes the arguments from the callback to produce a single item to yield on next.

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

      • Parameters

        • v1: T
        • v2: T2
        • v3: T3
        • v4: T4

        Returns Observable<R>

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • v3: T3
          • v4: T4
          • v5: T5
          • callback: function
              • (result: R): any

              • Parameters

                • result: R

                Returns any

          Returns any

    • Optional selector: void

      A selector which takes the arguments from the callback to produce a single item to yield on next.

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

      • (v1: T, v2: T2, v3: T3, v4: T4, v5: T5): Observable<R>

      • Parameters

        • v1: T
        • v2: T2
        • v3: T3
        • v4: T4
        • v5: T5

        Returns Observable<R>

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    • T6

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • v3: T3
          • v4: T4
          • v5: T5
          • v6: T6
          • callback: function
              • (result: R): any

              • Parameters

                • result: R

                Returns any

          Returns any

    • Optional selector: void

      A selector which takes the arguments from the callback to produce a single item to yield on next.

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

      • (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): Observable<R>

      • Parameters

        • v1: T
        • v2: T2
        • v3: T3
        • v4: T4
        • v5: T5
        • v6: T6

        Returns Observable<R>

  • Converts a callback function to an observable sequence.

    Type parameters

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (callback: function): any

        • Parameters

          • callback: function
              • (...args: any[]): any

              • Parameters

                • Rest ...args: any[]

                Returns any

          Returns any

    • selector: function

      A selector which takes the arguments from the callback to produce a single item to yield on next.

        • (...args: any[]): R

        • Parameters

          • Rest ...args: any[]

          Returns R

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (v1: T, callback: function): any

        • Parameters

          • v1: T
          • callback: function
              • (...args: any[]): any

              • Parameters

                • Rest ...args: any[]

                Returns any

          Returns any

    • selector: function

      A selector which takes the arguments from the callback to produce a single item to yield on next.

        • (...args: any[]): R

        • Parameters

          • Rest ...args: any[]

          Returns R

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    • T2

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (v1: T, v2: T2, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • callback: function
              • (...args: any[]): any

              • Parameters

                • Rest ...args: any[]

                Returns any

          Returns any

    • selector: function

      A selector which takes the arguments from the callback to produce a single item to yield on next.

        • (...args: any[]): R

        • Parameters

          • Rest ...args: any[]

          Returns R

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    • T2

    • T3

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (v1: T, v2: T2, v3: T3, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • v3: T3
          • callback: function
              • (...args: any[]): any

              • Parameters

                • Rest ...args: any[]

                Returns any

          Returns any

    • selector: function

      A selector which takes the arguments from the callback to produce a single item to yield on next.

        • (...args: any[]): R

        • Parameters

          • Rest ...args: any[]

          Returns R

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (v1: T, v2: T2, v3: T3, v4: T4, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • v3: T3
          • v4: T4
          • callback: function
              • (...args: any[]): any

              • Parameters

                • Rest ...args: any[]

                Returns any

          Returns any

    • selector: function

      A selector which takes the arguments from the callback to produce a single item to yield on next.

        • (...args: any[]): R

        • Parameters

          • Rest ...args: any[]

          Returns R

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

      • Parameters

        • v1: T
        • v2: T2
        • v3: T3
        • v4: T4

        Returns Observable<R>

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • v3: T3
          • v4: T4
          • v5: T5
          • callback: function
              • (...args: any[]): any

              • Parameters

                • Rest ...args: any[]

                Returns any

          Returns any

    • selector: function

      A selector which takes the arguments from the callback to produce a single item to yield on next.

        • (...args: any[]): R

        • Parameters

          • Rest ...args: any[]

          Returns R

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

      • (v1: T, v2: T2, v3: T3, v4: T4, v5: T5): Observable<R>

      • Parameters

        • v1: T
        • v2: T2
        • v3: T3
        • v4: T4
        • v5: T5

        Returns Observable<R>

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    • T6

    • R

    Parameters

    • callbackFunc: function

      Function with a callback as the last parameter.

        • (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • v3: T3
          • v4: T4
          • v5: T5
          • v6: T6
          • callback: function
              • (...args: any[]): any

              • Parameters

                • Rest ...args: any[]

                Returns any

          Returns any

    • selector: function

      A selector which takes the arguments from the callback to produce a single item to yield on next.

        • (...args: any[]): R

        • Parameters

          • Rest ...args: any[]

          Returns R

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

      • (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): Observable<R>

      • Parameters

        • v1: T
        • v2: T2
        • v3: T3
        • v4: T4
        • v5: T5
        • v6: T6

        Returns Observable<R>

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    Parameters

    • callbackFunc: Function

      Function with a callback as the last parameter.

    • Optional selector: void

      A selector which takes the arguments from the callback to produce a single item to yield on next.

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

  • Converts a callback function to an observable sequence.

    Type parameters

    • T

    Parameters

    • callbackFunc: Function

      Function with a callback as the last parameter.

    • Optional selector: function

      A selector which takes the arguments from the callback to produce a single item to yield on next.

        • (...args: any[]): T

        • Parameters

          • Rest ...args: any[]

          Returns T

    • Optional scheduler: Scheduler

    Returns function

    a function which returns the Observable that corresponds to the callback.

DispatchErrorArg

DispatchErrorArg:

err

err: any

subject

subject: AsyncSubject<T>

DispatchNextArg

DispatchNextArg:

subject

subject: AsyncSubject<T>

value

value: T

dispatch

  • dispatch<T>(state: object): void

  • Type parameters

    • T

    Parameters

    Returns void

dispatchError

  • Type parameters

    • T

    Parameters

    Returns void

dispatchNext

  • Type parameters

    • T

    Parameters

    Returns void

"node_modules/rxjs/src/observable/BoundNodeCallbackObservable"

"node_modules/rxjs/src/observable/BoundNodeCallbackObservable":

BoundNodeCallbackObservable

BoundNodeCallbackObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

args

args: any[]

callbackFunc

callbackFunc: Function

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

selector

selector: Function

source

source: Observable<any>

subject

subject: AsyncSubject<T>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • create<R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T, T2, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T, T2, T3, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T, T2, T3, T4, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T, T2, T3, T4, T5, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T, T2, T3, T4, T5, T6, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
  • create<T>(callbackFunc: Function, selector?: void, scheduler?: Scheduler): function
  • create<T>(callbackFunc: Function, selector?: function, scheduler?: Scheduler): function

  • Converts a node callback to an Observable.

    Type parameters

    • R

    Parameters

    • callbackFunc: function
        • (callback: function): any

        • Parameters

          • callback: function
              • (err: any, result: R): any

              • Parameters

                • err: any
                • result: R

                Returns any

          Returns any

    • Optional selector: void
    • Optional scheduler: Scheduler

    Returns function

  • Converts a node callback to an Observable.

    Type parameters

    • T

    • R

    Parameters

    • callbackFunc: function
        • (v1: T, callback: function): any

        • Parameters

          • v1: T
          • callback: function
              • (err: any, result: R): any

              • Parameters

                • err: any
                • result: R

                Returns any

          Returns any

    • Optional selector: void
    • Optional scheduler: Scheduler

    Returns function

  • Converts a node callback to an Observable.

    Type parameters

    • T

    • T2

    • R

    Parameters

    • callbackFunc: function
        • (v1: T, v2: T2, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • callback: function
              • (err: any, result: R): any

              • Parameters

                • err: any
                • result: R

                Returns any

          Returns any

    • Optional selector: void
    • Optional scheduler: Scheduler

    Returns function

  • Converts a node callback to an Observable.

    Type parameters

    • T

    • T2

    • T3

    • R

    Parameters

    • callbackFunc: function
        • (v1: T, v2: T2, v3: T3, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • v3: T3
          • callback: function
              • (err: any, result: R): any

              • Parameters

                • err: any
                • result: R

                Returns any

          Returns any

    • Optional selector: void
    • Optional scheduler: Scheduler

    Returns function

  • Converts a node callback to an Observable.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • R

    Parameters

    • callbackFunc: function
        • (v1: T, v2: T2, v3: T3, v4: T4, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • v3: T3
          • v4: T4
          • callback: function
              • (err: any, result: R): any

              • Parameters

                • err: any
                • result: R

                Returns any

          Returns any

    • Optional selector: void
    • Optional scheduler: Scheduler

    Returns function

      • Parameters

        • v1: T
        • v2: T2
        • v3: T3
        • v4: T4

        Returns Observable<R>

  • Converts a node callback to an Observable.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    • R

    Parameters

    • callbackFunc: function
        • (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • v3: T3
          • v4: T4
          • v5: T5
          • callback: function
              • (err: any, result: R): any

              • Parameters

                • err: any
                • result: R

                Returns any

          Returns any

    • Optional selector: void
    • Optional scheduler: Scheduler

    Returns function

      • (v1: T, v2: T2, v3: T3, v4: T4, v5: T5): Observable<R>

      • Parameters

        • v1: T
        • v2: T2
        • v3: T3
        • v4: T4
        • v5: T5

        Returns Observable<R>

  • Converts a node callback to an Observable.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    • T6

    • R

    Parameters

    • callbackFunc: function
        • (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, callback: function): any

        • Parameters

          • v1: T
          • v2: T2
          • v3: T3
          • v4: T4
          • v5: T5
          • v6: T6
          • callback: function
              • (err: any, result: R): any

              • Parameters

                • err: any
                • result: R

                Returns any

          Returns any

    • Optional selector: void
    • Optional scheduler: Scheduler

    Returns function

      • (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): Observable<R>

      • Parameters

        • v1: T
        • v2: T2
        • v3: T3
        • v4: T4
        • v5: T5
        • v6: T6

        Returns Observable<R>

  • Converts a node callback to an Observable.

    Type parameters

    • T

    Parameters

    • callbackFunc: Function
    • Optional selector: void
    • Optional scheduler: Scheduler

    Returns function

  • Converts a node callback to an Observable.

    Type parameters

    • T

    Parameters

    • callbackFunc: Function
    • Optional selector: function
        • (...args: any[]): T

        • Parameters

          • Rest ...args: any[]

          Returns T

    • Optional scheduler: Scheduler

    Returns function

DispatchErrorArg

DispatchErrorArg:

err

err: any

subject

subject: AsyncSubject<T>

DispatchNextArg

DispatchNextArg:

subject

subject: AsyncSubject<T>

value

value: T

dispatch

  • dispatch<T>(state: object): void

  • Type parameters

    • T

    Parameters

    Returns void

dispatchError

  • Type parameters

    • T

    Parameters

    Returns void

dispatchNext

  • Type parameters

    • T

    Parameters

    Returns void

"node_modules/rxjs/src/observable/ConnectableObservable"

"node_modules/rxjs/src/observable/ConnectableObservable":

ConnectableObservable

ConnectableObservable:
class

ConnectableObservable

constructor

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

source

source: Observable<T>

subject

subject: Subject<T>

subjectFactory

subjectFactory: function

Type declaration

subscription

subscription: Subscription

if

if: create

throw

throw: create

__computed

_closeSubscription

  • _closeSubscription(): void

  • This method is opened for ConnectableSubscription. Not to call from others.

    Returns void

_subscribe

connect

  • Returns Subscription

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

getSubject

  • Returns Subject<T>

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

refCount

  • Returns Observable<T>

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates a new cold Observable by calling the Observable constructor

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    a new cold observable

ConnectableSubscription

ConnectableSubscription:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

connectable

connectable: ConnectableObservable<any>

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

EMPTY

EMPTY: Subscription

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

  • Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

    Returns void

RefCountObservable

RefCountObservable:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

_isScalar

_isScalar: boolean

connectable

connectable: ConnectableObservable<T>

connection

connection: Subscription

operator

operator: Operator<any, T>

refCount

refCount: number

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates a new cold Observable by calling the Observable constructor

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    a new cold observable

RefCountSubscriber

RefCountSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

connection

connection: Subscription

destination

destination: Subscriber<T>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

refCountObservable

refCountObservable: RefCountObservable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_resetConnectable

  • _resetConnectable(): void

  • Returns void

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/observable/DeferObservable"

"node_modules/rxjs/src/observable/DeferObservable":

DeferObservable

DeferObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

observableFactory

observableFactory: function

Type declaration

operator

operator: Operator<any, T>

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • create<T>(observableFactory: function): Observable<T>

  • Creates an Observable that, on subscribe, calls an Observable factory to make an Observable for each new Observer.

    Creates the Observable lazily, that is, only when it is subscribed.

    defer allows you to create the Observable only when the Observer subscribes, and create a fresh Observable for each Observer. It waits until an Observer subscribes to it, and then it generates an Observable, typically with an Observable factory function. It does this afresh for each subscriber, so although each subscriber may think it is subscribing to the same Observable, in fact each subscriber gets its own individual Observable.

    example

    Subscribe to either an Observable of clicks or an Observable of interval, at random var clicksOrInterval = Rx.Observable.defer(function () { if (Math.random() > 0.5) { return Rx.Observable.fromEvent(document, 'click'); } else { return Rx.Observable.interval(1000); } }); clicksOrInterval.subscribe(x => console.log(x));

    see

    {@link create}

    static

    true

    name

    defer

    owner

    Observable

    Type parameters

    • T

    Parameters

    • observableFactory: function

      The Observable factory function to invoke for each Observer that subscribes to the output Observable. May also return a Promise, which will be converted on the fly to an Observable.

    Returns Observable<T>

    An Observable whose Observers' subscriptions trigger an invocation of the given Observable factory function.

DeferSubscriber

DeferSubscriber:

constructor

destination

destination: PartialObserver

factory

factory: function

Type declaration

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_callFactory

  • _callFactory(): void

  • Returns void

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

  • Parameters

    • outerValue: T
    • innerValue: T
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, T>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

tryDefer

  • tryDefer(): void

  • Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/observable/EmptyObservable"

"node_modules/rxjs/src/observable/EmptyObservable":

EmptyObservable

EmptyObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates an Observable that emits no items to the Observer and immediately emits a complete notification.

    Just emits 'complete', and nothing else.

    This static operator is useful for creating a simple Observable that only emits the complete notification. It can be used for composing with other Observables, such as in a mergeMap.

    example

    Emit the number 7, then complete. var result = Rx.Observable.empty().startWith(7); result.subscribe(x => console.log(x));

    example

    Map and flatten only odd numbers to the sequence 'a', 'b', 'c' var interval = Rx.Observable.interval(1000); var result = interval.mergeMap(x => x % 2 === 1 ? Rx.Observable.of('a', 'b', 'c') : Rx.Observable.empty() ); result.subscribe(x => console.log(x));

    see

    {@link create}

    see

    never

    see

    of

    see

    throw

    static

    true

    name

    empty

    owner

    Observable

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    An "empty" Observable: emits only the complete notification.

dispatch

  • Type parameters

    • T

    Parameters

    Returns void

DispatchArg

DispatchArg:

subscriber

subscriber: Subscriber<T>

"node_modules/rxjs/src/observable/ErrorObservable"

"node_modules/rxjs/src/observable/ErrorObservable":

ErrorObservable

ErrorObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

error

error: any

operator

operator: Operator<any, any>

scheduler

scheduler: Scheduler

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: any): void

        • Parameters

          • value: any

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<any, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates an Observable that emits no items to the Observer and immediately emits an error notification.

    Just emits 'error', and nothing else.

    This static operator is useful for creating a simple Observable that only emits the error notification. It can be used for composing with other Observables, such as in a mergeMap.

    example

    Emit the number 7, then emit an error. var result = Rx.Observable.throw(new Error('oops!')).startWith(7); result.subscribe(x => console.log(x), e => console.error(e));

    example

    Map and flattens numbers to the sequence 'a', 'b', 'c', but throw an error for 13 var interval = Rx.Observable.interval(1000); var result = interval.mergeMap(x => x === 13 ? Rx.Observable.throw('Thirteens are bad') : Rx.Observable.of('a', 'b', 'c') ); result.subscribe(x => console.log(x), e => console.error(e));

    see

    {@link create}

    see

    empty

    see

    never

    see

    of

    static

    true

    name

    throw

    owner

    Observable

    Type parameters

    • T

    Parameters

    • error: any

      The particular Error to pass to the error notification.

    • Optional scheduler: Scheduler

    Returns ErrorObservable

    An error Observable: emits only the error notification using the given error argument.

dispatch

  • Parameters

    Returns void

DispatchArg

DispatchArg:

error

error: any

subscriber

subscriber: any

"node_modules/rxjs/src/observable/ForkJoinObservable"

"node_modules/rxjs/src/observable/ForkJoinObservable":

ForkJoinObservable

ForkJoinObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

resultSelector

resultSelector: function

Type declaration

    • (...values: Array<any>): T

    • Parameters

      • Rest ...values: Array<any>

      Returns T

source

source: Observable<any>

sources

sources: Array<SubscribableOrPromise>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

ForkJoinSubscriber

ForkJoinSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

completed

completed: number

destination

destination: PartialObserver

haveValues

haveValues: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

resultSelector

resultSelector: function

Type declaration

    • (...values: Array<any>): T

    • Parameters

      • Rest ...values: Array<any>

      Returns T

sources

sources: Array<SubscribableOrPromise>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

total

total: number

values

values: any[]

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: any, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

  • Parameters

    • outerValue: any
    • innerValue: T
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, T>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/observable/FromEventObservable"

"node_modules/rxjs/src/observable/FromEventObservable":

FromEventObservable

FromEventObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

  • Parameters

    • sourceObj: EventTargetLike
    • eventName: string
    • Optional selector: function
        • (...args: Array<any>): T

        • Parameters

          • Rest ...args: Array<any>

          Returns T

    Returns FromEventObservable

_isScalar

_isScalar: boolean

eventName

eventName: string

operator

operator: Operator<any, T>

selector

selector: function

Type declaration

    • (...args: Array<any>): T

    • Parameters

      • Rest ...args: Array<any>

      Returns T

source

source: Observable<any>

sourceObj

sourceObj: EventTargetLike

if

if: create

throw

throw: create

__computed

_subscribe

  • Parameters

    Returns void

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • static

    true

    name

    fromEvent

    owner

    Observable

    Type parameters

    • T

    Parameters

    • sourceObj: EventTargetLike
    • eventName: string
    • Optional selector: function
        • (...args: Array<any>): T

        • Parameters

          • Rest ...args: Array<any>

          Returns T

    Returns Observable<T>

setupSubscription

  • Type parameters

    • T

    Parameters

    Returns void

EventTargetLike

EventTargetLike: EventTarget | NodeStyleEventEmmitter | JQueryStyleEventEmitter | NodeList | HTMLCollection

JQueryStyleEventEmitter

JQueryStyleEventEmitter: object

Type declaration

  • off: function
      • (eventName: string, handler: Function): void

      • Parameters

        • eventName: string
        • handler: Function

        Returns void

  • on: function
      • (eventName: string, handler: Function): void

      • Parameters

        • eventName: string
        • handler: Function

        Returns void

NodeStyleEventEmmitter

NodeStyleEventEmmitter: object

Type declaration

  • addListener: function
      • (eventName: string, handler: Function): void

      • Parameters

        • eventName: string
        • handler: Function

        Returns void

  • removeListener: function
      • (eventName: string, handler: Function): void

      • Parameters

        • eventName: string
        • handler: Function

        Returns void

isEventTarget

  • isEventTarget(sourceObj: any): boolean

  • Parameters

    • sourceObj: any

    Returns boolean

isHTMLCollection

  • isHTMLCollection(sourceObj: any): boolean

  • Parameters

    • sourceObj: any

    Returns boolean

isJQueryStyleEventEmitter

  • isJQueryStyleEventEmitter(sourceObj: any): boolean

  • Parameters

    • sourceObj: any

    Returns boolean

isNodeList

  • isNodeList(sourceObj: any): boolean

  • Parameters

    • sourceObj: any

    Returns boolean

isNodeStyleEventEmmitter

  • isNodeStyleEventEmmitter(sourceObj: any): boolean

  • Parameters

    • sourceObj: any

    Returns boolean

"node_modules/rxjs/src/observable/FromEventPatternObservable"

"node_modules/rxjs/src/observable/FromEventPatternObservable":

FromEventPatternObservable

FromEventPatternObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

  • Parameters

    • addHandler: function
        • (handler: Function): any

        • Parameters

          • handler: Function

          Returns any

    • removeHandler: function
        • (handler: Function): void

        • Parameters

          • handler: Function

          Returns void

    • Optional selector: function
        • (...args: Array<any>): T

        • Parameters

          • Rest ...args: Array<any>

          Returns T

    Returns FromEventPatternObservable

_isScalar

_isScalar: boolean

addHandler

addHandler: function

Type declaration

    • (handler: Function): any

    • Parameters

      • handler: Function

      Returns any

operator

operator: Operator<any, T>

removeHandler

removeHandler: function

Type declaration

    • (handler: Function): void

    • Parameters

      • handler: Function

      Returns void

selector

selector: function

Type declaration

    • (...args: Array<any>): T

    • Parameters

      • Rest ...args: Array<any>

      Returns T

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

  • Parameters

    Returns void

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • static

    true

    name

    fromEventPattern

    owner

    Observable

    Type parameters

    • T

    Parameters

    • addHandler: function
        • (handler: Function): any

        • Parameters

          • handler: Function

          Returns any

    • removeHandler: function
        • (handler: Function): void

        • Parameters

          • handler: Function

          Returns void

    • Optional selector: function
        • (...args: Array<any>): T

        • Parameters

          • Rest ...args: Array<any>

          Returns T

    Returns FromEventPatternObservable<T, Object>

"node_modules/rxjs/src/observable/FromObservable"

"node_modules/rxjs/src/observable/FromObservable":

FromObservable

FromObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

ish

ish: ObservableInput

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • static

    true

    name

    from

    owner

    Observable

    Type parameters

    • T

    Parameters

    Returns Observable<T>

  • Type parameters

    • T

    • R

    Parameters

    • ish: ArrayLike<T>
    • mapFn: function
        • (x: any, y: number): R

        • Parameters

          • x: any
          • y: number

          Returns R

    • Optional thisArg: any
    • Optional scheduler: Scheduler

    Returns Observable<R>

isArrayLike

isArrayLike: (Anonymous function)

"node_modules/rxjs/src/observable/IfObservable"

"node_modules/rxjs/src/observable/IfObservable":

IfObservable

IfObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

condition

condition: function

Type declaration

    • (): boolean | void

    • Returns boolean | void

elseSource

elseSource: SubscribableOrPromise | void

operator

operator: Operator<any, T>

source

source: Observable<any>

thenSource

thenSource: SubscribableOrPromise | void

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

IfSubscriber

IfSubscriber:

constructor

condition

condition: function

Type declaration

    • (): boolean | void

    • Returns boolean | void

destination

destination: PartialObserver

elseSource

elseSource: SubscribableOrPromise | void

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

thenSource

thenSource: SubscribableOrPromise | void

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

  • Parameters

    • outerValue: T
    • innerValue: T
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, T>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

tryIf

  • tryIf(): void

  • Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/observable/IntervalObservable"

"node_modules/rxjs/src/observable/IntervalObservable":

IntervalObservable

IntervalObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

operator

operator: Operator<any, number>

period

period: number

scheduler

scheduler: Scheduler

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

  • _subscribe(subscriber: Subscriber<number>): void

  • Parameters

    Returns void

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: number): void

        • Parameters

          • value: number

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<number, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates an Observable that emits sequential numbers every specified interval of time, on a specified Scheduler.

    Emits incremental numbers periodically in time.

    interval returns an Observable that emits an infinite sequence of ascending integers, with a constant interval of time of your choosing between those emissions. The first emission is not sent immediately, but only after the first period has passed. By default, this operator uses the async Scheduler to provide a notion of time, but you may pass any Scheduler to it.

    example

    Emits ascending numbers, one every second (1000ms) var numbers = Rx.Observable.interval(1000); numbers.subscribe(x => console.log(x));

    see

    timer

    see

    delay

    static

    true

    name

    interval

    owner

    Observable

    Parameters

    • Default value period: number = 0
    • Default value scheduler: Scheduler = async

    Returns Observable<number>

    An Observable that emits a sequential number each time interval.

dispatch

  • dispatch(state: any): void

  • Parameters

    • state: any

    Returns void

"node_modules/rxjs/src/observable/IteratorObservable"

"node_modules/rxjs/src/observable/IteratorObservable":

ArrayIterator

ArrayIterator:

constructor

  • new ArrayIterator(arr: Array<any>, idx?: number, len?: number): ArrayIterator

  • Parameters

    • arr: Array<any>
    • Default value idx: number = 0
    • Default value len: number = toLength(arr)

    Returns ArrayIterator

arr

arr: Array<any>

idx

idx: number

len

len: number

__computed

  • Returns ArrayIterator

next

  • next(): object

  • Returns object

    • done: boolean
    • value: any

IteratorObservable

IteratorObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

iterator

iterator: any

operator

operator: Operator<any, T>

project

project: function

Type declaration

    • (x?: any, i?: number): T

    • Parameters

      • Optional x: any
      • Optional i: number

      Returns T

scheduler

scheduler: Scheduler

source

source: Observable<any>

thisArg

thisArg: any

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Type parameters

    • T

    Parameters

    • iterator: any
    • Optional project: function | any
    • Optional thisArg: any | Scheduler
    • Optional scheduler: Scheduler

    Returns IteratorObservable<Object>

dispatch

  • dispatch(state: any): void

  • Parameters

    • state: any

    Returns void

StringIterator

StringIterator:

constructor

  • new StringIterator(str: string, idx?: number, len?: number): StringIterator

  • Parameters

    • str: string
    • Default value idx: number = 0
    • Default value len: number = str.length

    Returns StringIterator

idx

idx: number

len

len: number

str

str: string

__computed

  • Returns StringIterator

next

  • next(): object

  • Returns object

    • done: boolean
    • value: string

maxSafeInteger

maxSafeInteger: number

getIterator

  • getIterator(obj: any): any

  • Parameters

    • obj: any

    Returns any

numberIsFinite

  • numberIsFinite(value: any): any

  • Parameters

    • value: any

    Returns any

sign

  • sign(value: any): number

  • Parameters

    • value: any

    Returns number

toLength

  • toLength(o: any): number

  • Parameters

    • o: any

    Returns number

"node_modules/rxjs/src/observable/NeverObservable"

"node_modules/rxjs/src/observable/NeverObservable":

NeverObservable

NeverObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

  • Parameters

    Returns void

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates an Observable that emits no items to the Observer.

    An Observable that never emits anything.

    This static operator is useful for creating a simple Observable that emits neither values nor errors nor the completion notification. It can be used for testing purposes or for composing with other Observables. Please not that by never emitting a complete notification, this Observable keeps the subscription from being disposed automatically. Subscriptions need to be manually disposed.

    example

    Emit the number 7, then never emit anything else (not even complete). function info() { console.log('Will not be called'); } var result = Rx.Observable.never().startWith(7); result.subscribe(x => console.log(x), info, info);

    see

    {@link create}

    see

    empty

    see

    of

    see

    throw

    static

    true

    name

    never

    owner

    Observable

    Type parameters

    • T

    Returns NeverObservable<T>

    A "never" Observable: never emits anything.

"node_modules/rxjs/src/observable/PromiseObservable"

"node_modules/rxjs/src/observable/PromiseObservable":

PromiseObservable

PromiseObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

promise

promise: Promise<T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

value

value: T

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • static

    true

    name

    fromPromise

    owner

    Observable

    Type parameters

    • T

    Parameters

    • promise: Promise<T>
    • Default value scheduler: Scheduler = null

    Returns Observable<T>

DispatchErrorArg

DispatchErrorArg:

err

err: any

subscriber

subscriber: Subscriber<T>

DispatchNextArg

DispatchNextArg:

subscriber

subscriber: Subscriber<T>

value

value: T

dispatchError

  • Type parameters

    • T

    Parameters

    Returns void

dispatchNext

  • Type parameters

    • T

    Parameters

    Returns void

"node_modules/rxjs/src/observable/RangeObservable"

"node_modules/rxjs/src/observable/RangeObservable":

RangeObservable

RangeObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_count

_count: number

_isScalar

_isScalar: boolean

operator

operator: Operator<any, number>

scheduler

scheduler: Scheduler

source

source: Observable<any>

start

start: number

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: number): void

        • Parameters

          • value: number

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<number, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates an Observable that emits a sequence of numbers within a specified range.

    Emits a sequence of numbers in a range.

    range operator emits a range of sequential integers, in order, where you select the start of the range and its length. By default, uses no Scheduler and just delivers the notifications synchronously, but may use an optional Scheduler to regulate those deliveries.

    example

    Emits the numbers 1 to 10 var numbers = Rx.Observable.range(1, 10); numbers.subscribe(x => console.log(x));

    see

    timer

    see

    interval

    static

    true

    name

    range

    owner

    Observable

    Parameters

    • Default value start: number = 0
    • Default value count: number = 0
    • Optional scheduler: Scheduler

    Returns Observable<number>

    An Observable of numbers that emits a finite range of sequential integers.

dispatch

  • dispatch(state: any): void

  • Parameters

    • state: any

    Returns void

"node_modules/rxjs/src/observable/ScalarObservable"

"node_modules/rxjs/src/observable/ScalarObservable":

ScalarObservable

ScalarObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

value

value: T

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

dispatch

  • dispatch(state: any): void

  • Parameters

    • state: any

    Returns void

"node_modules/rxjs/src/observable/SubscribeOnObservable"

"node_modules/rxjs/src/observable/SubscribeOnObservable":

SubscribeOnObservable

SubscribeOnObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

delayTime

delayTime: number

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<T>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Type parameters

    • T

    Parameters

    • source: Observable<T>
    • Default value delay: number = 0
    • Default value scheduler: Scheduler = asap

    Returns Observable<T>

dispatch

  • Type parameters

    • T

    Parameters

    Returns Subscription

DispatchArg

DispatchArg:

source

source: Observable<T>

subscriber

subscriber: Subscriber<T>

"node_modules/rxjs/src/observable/TimerObservable"

"node_modules/rxjs/src/observable/TimerObservable":

TimerObservable

TimerObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

dueTime

dueTime: number

operator

operator: Operator<any, number>

period

period: number

scheduler

scheduler: Scheduler

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: number): void

        • Parameters

          • value: number

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<number, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates an Observable that starts emitting after an initialDelay and emits ever increasing numbers after each period of time thereafter.

    Its like interval, but you can specify when should the emissions start.

    timer returns an Observable that emits an infinite sequence of ascending integers, with a constant interval of time, period of your choosing between those emissions. The first emission happens after the specified initialDelay. The initial delay may be a {@link Date}. By default, this operator uses the async Scheduler to provide a notion of time, but you may pass any Scheduler to it. If period is not specified, the output Observable emits only one value, 0. Otherwise, it emits an infinite sequence.

    example

    Emits ascending numbers, one every second (1000ms), starting after 3 seconds var numbers = Rx.Observable.timer(3000, 1000); numbers.subscribe(x => console.log(x));

    example

    Emits one number after five seconds var numbers = Rx.Observable.timer(5000); numbers.subscribe(x => console.log(x));

    see

    interval

    see

    delay

    static

    true

    name

    timer

    owner

    Observable

    Parameters

    • Default value initialDelay: number | Date = 0

      The initial delay time to wait before emitting the first value of 0.

    • Optional period: number | Scheduler
    • Optional scheduler: Scheduler

    Returns Observable<number>

    An Observable that emits a 0 after the initialDelay and ever increasing numbers after each period of time thereafter.

dispatch

  • dispatch(state: any): any

  • Parameters

    • state: any

    Returns any

"node_modules/rxjs/src/observable/UsingObservable"

"node_modules/rxjs/src/observable/UsingObservable":

UsingObservable

UsingObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

  • new UsingObservable(resourceFactory: function, observableFactory: function): UsingObservable

_isScalar

_isScalar: boolean

observableFactory

observableFactory: function

Type declaration

operator

operator: Operator<any, T>

resourceFactory

resourceFactory: function

Type declaration

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • create<T>(resourceFactory: function, observableFactory: function): Observable<T>

UsingSubscriber

UsingSubscriber:

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

observableFactory

observableFactory: function

Type declaration

resource

resource: AnonymousSubscription

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

  • Parameters

    • outerValue: T
    • innerValue: T
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, T>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

tryUse

  • tryUse(): void

  • Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/observable/bindCallback"

"node_modules/rxjs/src/observable/bindCallback":

bindCallback

bindCallback: create

"node_modules/rxjs/src/observable/bindNodeCallback"

"node_modules/rxjs/src/observable/bindNodeCallback":

bindNodeCallback

bindNodeCallback: create

"node_modules/rxjs/src/observable/concat"

"node_modules/rxjs/src/observable/concat":

concat

concat: concatStatic

"node_modules/rxjs/src/observable/defer"

"node_modules/rxjs/src/observable/defer":

defer

defer: create

"node_modules/rxjs/src/observable/dom/AjaxObservable"

"node_modules/rxjs/src/observable/dom/AjaxObservable":

AjaxError

AjaxError:

A normalized AJAX error.

see

ajax

class

AjaxError

constructor

  • Parameters

    • message: string
    • xhr: XMLHttpRequest
    • request: AjaxRequest

    Returns AjaxError

request

request: AjaxRequest
type

{AjaxRequest} The AjaxRequest associated with the error

status

status: number
type

{number} The HTTP status code

xhr

xhr: XMLHttpRequest
type

{XMLHttpRequest} The XHR instance associated with the error

Error

Error: ErrorConstructor

message

message: string

name

name: string

stack

stack: string

AjaxObservable

AjaxObservable:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

request

request: AjaxRequest

source

source: Observable<any>

create

create: AjaxCreationMethod

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

_create_stub

  • _create_stub(): void

  • Creates an observable for an Ajax request with either a request object with url, headers, etc or a string for a URL.

    example

    source = Rx.Observable.ajax('/products'); source = Rx.Observable.ajax( url: 'products', method: 'GET' });

    static

    true

    name

    ajax

    owner

    Observable

    Returns void

    An observable sequence containing the XMLHttpRequest.

AjaxResponse

AjaxResponse:

A normalized AJAX response.

see

ajax

class

AjaxResponse

constructor

  • Parameters

    • originalEvent: Event
    • xhr: XMLHttpRequest
    • request: AjaxRequest

    Returns AjaxResponse

originalEvent

originalEvent: Event

request

request: AjaxRequest

response

response: any
type

{string|ArrayBuffer|Document|object|any} The response data

responseText

responseText: string
type

{string} The raw responseText

responseType

responseType: string
type

{string} The responseType (e.g. 'json', 'arraybuffer', or 'xml')

status

status: number
type

{number} The HTTP status code

xhr

xhr: XMLHttpRequest

AjaxSubscriber

AjaxSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

done

done: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

request

request: AjaxRequest

resultSelector

resultSelector: function

Type declaration

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

xhr

xhr: XMLHttpRequest

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: Event): void

  • Parameters

    • value: Event

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(e: Event): void

  • Parameters

    • e: Event

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

send

  • send(): XMLHttpRequest

  • Returns XMLHttpRequest

serializeBody

  • serializeBody(body: any, contentType: string): any

  • Parameters

    • body: any
    • contentType: string

    Returns any

setHeaders

  • setHeaders(xhr: XMLHttpRequest, headers: Object): void

  • Parameters

    • xhr: XMLHttpRequest
    • headers: Object

    Returns void

setupEvents

  • setupEvents(xhr: XMLHttpRequest, request: AjaxRequest): void

  • Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

AjaxTimeoutError

AjaxTimeoutError:
see

ajax

class

AjaxTimeoutError

constructor

request

request: AjaxRequest
type

{AjaxRequest} The AjaxRequest associated with the error

status

status: number
type

{number} The HTTP status code

xhr

xhr: XMLHttpRequest
type

{XMLHttpRequest} The XHR instance associated with the error

message

message: string

name

name: string

stack

stack: string

AjaxCreationMethod

  • Type parameters

    • T

    Parameters

    Returns Observable<T>

delete

  • delete<T>(url: string, headers?: Object): Observable<T>

  • Type parameters

    • T

    Parameters

    • url: string
    • Optional headers: Object

    Returns Observable<T>

get

  • get<T>(url: string, resultSelector?: function, headers?: Object): Observable<T>

  • Type parameters

    • T

    Parameters

    • url: string
    • Optional resultSelector: function
    • Optional headers: Object

    Returns Observable<T>

getJSON

  • getJSON<T, R>(url: string, resultSelector?: function, headers?: Object): Observable<R>

  • Type parameters

    • T

    • R

    Parameters

    • url: string
    • Optional resultSelector: function
        • (data: T): R

        • Parameters

          • data: T

          Returns R

    • Optional headers: Object

    Returns Observable<R>

post

  • post<T>(url: string, body?: any, headers?: Object): Observable<T>

  • Type parameters

    • T

    Parameters

    • url: string
    • Optional body: any
    • Optional headers: Object

    Returns Observable<T>

put

  • put<T>(url: string, body?: any, headers?: Object): Observable<T>

  • Type parameters

    • T

    Parameters

    • url: string
    • Optional body: any
    • Optional headers: Object

    Returns Observable<T>

AjaxRequest

AjaxRequest:

async

async: boolean

body

body: any

createXHR

createXHR: function

Type declaration

    • (): XMLHttpRequest

    • Returns XMLHttpRequest

crossDomain

crossDomain: boolean

hasContent

hasContent: boolean

headers

headers: Object

method

method: string

password

password: string

progressSubscriber

progressSubscriber: Subscriber<any>

responseType

responseType: string

resultSelector

resultSelector: function

Type declaration

timeout

timeout: number

url

url: string

user

user: string

ajaxDelete

  • ajaxDelete<T>(url: string, headers?: Object): Observable<T>

  • Type parameters

    • T

    Parameters

    • url: string
    • Optional headers: Object

    Returns Observable<T>

ajaxGet

  • ajaxGet<T>(url: string, resultSelector?: function, headers?: Object): AjaxObservable<T>

  • Type parameters

    • T

    Parameters

    • url: string
    • Default value resultSelector: function = defaultGetResultSelector
    • Default value headers: Object = null

    Returns AjaxObservable<T>

ajaxGetJSON

  • ajaxGetJSON<T, R>(url: string, resultSelector?: function, headers?: Object): Observable<R>

  • Type parameters

    • T

    • R

    Parameters

    • url: string
    • Optional resultSelector: function
        • (data: T): R

        • Parameters

          • data: T

          Returns R

    • Optional headers: Object

    Returns Observable<R>

ajaxPost

  • ajaxPost<T>(url: string, body?: any, headers?: Object): Observable<T>

  • Type parameters

    • T

    Parameters

    • url: string
    • Optional body: any
    • Optional headers: Object

    Returns Observable<T>

ajaxPut

  • ajaxPut<T>(url: string, body?: any, headers?: Object): Observable<T>

  • Type parameters

    • T

    Parameters

    • url: string
    • Optional body: any
    • Optional headers: Object

    Returns Observable<T>

createXHRDefault

  • createXHRDefault(): XMLHttpRequest

  • Returns XMLHttpRequest

defaultGetResultSelector

  • Type parameters

    • T

    Parameters

    Returns T

"node_modules/rxjs/src/observable/dom/MiscJSDoc"

"node_modules/rxjs/src/observable/dom/MiscJSDoc":

AjaxRequestDoc

AjaxRequestDoc:
see

ajax

interface
name

AjaxRequest

noimport

true

async

async: boolean
type

{boolean}

body

body: any
type

{number}

crossDomain

crossDomain: boolean
type

{boolean}

hasContent

hasContent: boolean
type

{boolean}

headers

headers: Object
type

{Object}

method

method: string
type

{string}

password

password: string
type

{string}

progressSubscriber

progressSubscriber: Subscriber<any>
type

{Subscriber}

responseType

responseType: string
type

{string}

timeout

timeout: number
type

{number}

url

url: string
type

{string}

user

user: string
type

{string}

createXHR

  • createXHR(): XMLHttpRequest

  • Returns XMLHttpRequest

resultSelector

  • Type parameters

    • T

    Parameters

    Returns T

"node_modules/rxjs/src/observable/dom/WebSocketSubject"

"node_modules/rxjs/src/observable/dom/WebSocketSubject":

WebSocketSubject

WebSocketSubject:

We need this JSDoc comment for affecting ESDoc.

extends

{Ignored}

hide

true

constructor

WebSocketCtor

WebSocketCtor: object

Type declaration

  • constructor: function
    • new __type(url: string, protocol?: string | Array<string>): __type

    • Parameters

      • url: string
      • Optional protocol: string | Array<string>

      Returns __type

_isScalar

_isScalar: boolean

closeObserver

closeObserver: NextObserver<CloseEvent>

closingObserver

closingObserver: NextObserver<void>

destination

destination: Observer<T>

dispatching

dispatching: boolean

errorValue

errorValue: any

hasCompleted

hasCompleted: boolean

hasErrored

hasErrored: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

observers

observers: Observer<T>[]

openObserver

openObserver: NextObserver<Event>

operator

operator: Operator<any, T>

protocol

protocol: string | Array<string>

socket

socket: WebSocket

source

source: Observable<T>

url

url: string

if

if: create

throw

throw: create

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_finalComplete

  • _finalComplete(): void

_finalError

  • _finalError(err: any): void

  • Parameters

    • err: any

    Returns void

_finalNext

  • _finalNext(value: T): void

  • Parameters

    • value: T

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_subscribe

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

asObservable

complete

  • complete(): void

  • Returns void

error

  • error(err?: any): void

  • Parameters

    • Optional err: any

    Returns void

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Type parameters

    • R

    Parameters

    Returns WebSocketSubject<T>

multiplex

  • multiplex(subMsg: function, unsubMsg: function, messageFilter: function): Observable<Object>

  • Parameters

    • subMsg: function
        • (): any

        • Returns any

    • unsubMsg: function
        • (): any

        • Returns any

    • messageFilter: function
        • (value: T): boolean

        • Parameters

          • value: T

          Returns boolean

    Returns Observable<Object>

next

  • next(value: T): void

  • Parameters

    • value: T

    Returns void

remove

  • Parameters

    Returns void

resultSelector

  • resultSelector(e: MessageEvent): any

  • Parameters

    • e: MessageEvent

    Returns any

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

unsubscribe

  • unsubscribe(): void

create

WebSocketSubjectConfig

WebSocketSubjectConfig:

WebSocketCtor

WebSocketCtor: object

Type declaration

  • constructor: function
    • new __type(url: string, protocol?: string | Array<string>): __type

    • Parameters

      • url: string
      • Optional protocol: string | Array<string>

      Returns __type

closeObserver

closeObserver: NextObserver<CloseEvent>

closingObserver

closingObserver: NextObserver<void>

openObserver

openObserver: NextObserver<Event>

protocol

protocol: string | Array<string>

resultSelector

resultSelector: function

Type declaration

    • <T>(e: MessageEvent): T

    • Type parameters

      • T

      Parameters

      • e: MessageEvent

      Returns T

url

url: string

"node_modules/rxjs/src/observable/dom/ajax"

"node_modules/rxjs/src/observable/dom/ajax":

ajax

ajax: AjaxCreationMethod

"node_modules/rxjs/src/observable/dom/webSocket"

"node_modules/rxjs/src/observable/dom/webSocket":

webSocket

webSocket: create

"node_modules/rxjs/src/observable/empty"

"node_modules/rxjs/src/observable/empty":

empty

empty: create

"node_modules/rxjs/src/observable/forkJoin"

"node_modules/rxjs/src/observable/forkJoin":

forkJoin

forkJoin: create

"node_modules/rxjs/src/observable/from"

"node_modules/rxjs/src/observable/from":

from

from: create

"node_modules/rxjs/src/observable/fromEvent"

"node_modules/rxjs/src/observable/fromEvent":

fromEvent

fromEvent: create

"node_modules/rxjs/src/observable/fromEventPattern"

"node_modules/rxjs/src/observable/fromEventPattern":

fromEventPattern

fromEventPattern: create

"node_modules/rxjs/src/observable/fromPromise"

"node_modules/rxjs/src/observable/fromPromise":

fromPromise

fromPromise: create

"node_modules/rxjs/src/observable/if"

"node_modules/rxjs/src/observable/if":

_if

_if: create

"node_modules/rxjs/src/observable/interval"

"node_modules/rxjs/src/observable/interval":

interval

interval: create

"node_modules/rxjs/src/observable/merge"

"node_modules/rxjs/src/observable/merge":

merge

merge: mergeStatic

"node_modules/rxjs/src/observable/never"

"node_modules/rxjs/src/observable/never":

never

never: create

"node_modules/rxjs/src/observable/of"

"node_modules/rxjs/src/observable/of":

of

of: of

"node_modules/rxjs/src/observable/range"

"node_modules/rxjs/src/observable/range":

range

range: create

"node_modules/rxjs/src/observable/throw"

"node_modules/rxjs/src/observable/throw":

_throw

_throw: create

"node_modules/rxjs/src/observable/timer"

"node_modules/rxjs/src/observable/timer":

timer

timer: create

"node_modules/rxjs/src/observable/using"

"node_modules/rxjs/src/observable/using":

using

using: create

"node_modules/rxjs/src/observable/zip"

"node_modules/rxjs/src/observable/zip":

zip

zip: zipStatic

"node_modules/rxjs/src/operator/audit"

"node_modules/rxjs/src/operator/audit":

AuditOperator

AuditOperator:

constructor

durationSelector

durationSelector: function

Type declaration

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

AuditSubscriber

AuditSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

durationSelector

durationSelector: function

Type declaration

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

throttled

throttled: Subscription

value

value: T

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

clearThrottle

  • clearThrottle(): void

  • Returns void

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

  • notifyComplete(): void

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

AuditSignature

  • __call(durationSelector: function): Observable<T>

audit

  • audit<T>(durationSelector: function): Observable<T>

"node_modules/rxjs/src/operator/auditTime"

"node_modules/rxjs/src/operator/auditTime":

AuditTimeOperator

AuditTimeOperator:

constructor

  • Parameters

    Returns AuditTimeOperator

delay

delay: number

scheduler

scheduler: Scheduler

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

AuditTimeSubscriber

AuditTimeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

delay

delay: number

destination

destination: PartialObserver

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

throttled

throttled: Subscription

value

value: T

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

clearThrottle

  • clearThrottle(): void

  • Returns void

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

AuditTimeSignature

  • Parameters

    • delay: number
    • Optional scheduler: Scheduler

    Returns Observable<T>

auditTime

  • method

    auditTime

    owner

    Observable

    Type parameters

    • T

    Parameters

    • delay: number
    • Default value scheduler: Scheduler = async

    Returns Observable<T>

dispatchNext

  • Type parameters

    • T

    Parameters

    Returns void

"node_modules/rxjs/src/operator/buffer"

"node_modules/rxjs/src/operator/buffer":

BufferOperator

BufferOperator:

constructor

  • Parameters

    Returns BufferOperator

closingNotifier

closingNotifier: Observable<any>

call

  • call(subscriber: Subscriber<T[]>, source: any): any

  • Parameters

    Returns any

BufferSubscriber

BufferSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

buffer

buffer: T[]

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, any>): void

  • Parameters

    • outerValue: T
    • innerValue: any
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, any>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

BufferSignature

  • Parameters

    Returns Observable<T[]>

buffer

  • Buffers the source Observable values until closingNotifier emits.

    Collects values from the past as an array, and emits that array only when another Observable emits.

    Buffers the incoming Observable values until the given closingNotifier Observable emits a value, at which point it emits the buffer on the output Observable and starts a new buffer internally, awaiting the next time closingNotifier emits.

    example

    On every click, emit array of most recent interval events var clicks = Rx.Observable.fromEvent(document, 'click'); var interval = Rx.Observable.interval(1000); var buffered = interval.buffer(clicks); buffered.subscribe(x => console.log(x));

    see

    bufferCount

    see

    bufferTime

    see

    bufferToggle

    see

    bufferWhen

    see

    window

    method

    buffer

    owner

    Observable

    Type parameters

    • T

    Parameters

    • closingNotifier: Observable<any>

      An Observable that signals the buffer to be emitted on the output Observable.

    Returns Observable<T[]>

    An Observable of buffers, which are arrays of values.

"node_modules/rxjs/src/operator/bufferCount"

"node_modules/rxjs/src/operator/bufferCount":

BufferCountOperator

BufferCountOperator:

constructor

  • Parameters

    • bufferSize: number
    • startBufferEvery: number

    Returns BufferCountOperator

bufferSize

bufferSize: number

startBufferEvery

startBufferEvery: number

call

  • call(subscriber: Subscriber<T[]>, source: any): any

  • Parameters

    Returns any

BufferCountSubscriber

BufferCountSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

bufferSize

bufferSize: number

buffers

buffers: Array<T[]>

count

count: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

startBufferEvery

startBufferEvery: number

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

BufferCountSignature

  • __call(bufferSize: number, startBufferEvery?: number): Observable<T[]>

  • Parameters

    • bufferSize: number
    • Optional startBufferEvery: number

    Returns Observable<T[]>

bufferCount

  • bufferCount<T>(bufferSize: number, startBufferEvery?: number): Observable<T[]>

  • Buffers the source Observable values until the size hits the maximum bufferSize given.

    Collects values from the past as an array, and emits that array only when its size reaches bufferSize.

    Buffers a number of values from the source Observable by bufferSize then emits the buffer and clears it, and starts a new buffer each startBufferEvery values. If startBufferEvery is not provided or is null, then new buffers are started immediately at the start of the source and when each buffer closes and is emitted.

    example

    Emit the last two click events as an array var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferCount(2); buffered.subscribe(x => console.log(x));

    example

    On every click, emit the last two click events as an array var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferCount(2, 1); buffered.subscribe(x => console.log(x));

    see

    buffer

    see

    bufferTime

    see

    bufferToggle

    see

    bufferWhen

    see

    windowCount

    method

    bufferCount

    owner

    Observable

    Type parameters

    • T

    Parameters

    • bufferSize: number

      The maximum size of the buffer emitted.

    • Default value startBufferEvery: number = null

    Returns Observable<T[]>

    An Observable of arrays of buffered values.

"node_modules/rxjs/src/operator/bufferTime"

"node_modules/rxjs/src/operator/bufferTime":

BufferTimeOperator

BufferTimeOperator:

constructor

  • Parameters

    • bufferTimeSpan: number
    • bufferCreationInterval: number
    • scheduler: Scheduler

    Returns BufferTimeOperator

bufferCreationInterval

bufferCreationInterval: number

bufferTimeSpan

bufferTimeSpan: number

scheduler

scheduler: Scheduler

call

  • call(subscriber: Subscriber<T[]>, source: any): any

  • Parameters

    Returns any

BufferTimeSubscriber

BufferTimeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

bufferCreationInterval

bufferCreationInterval: number

bufferTimeSpan

bufferTimeSpan: number

buffers

buffers: Array<T[]>

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

closeBuffer

  • closeBuffer(buffer: T[]): void

  • Parameters

    • buffer: T[]

    Returns void

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

openBuffer

  • openBuffer(): T[]

  • Returns T[]

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

BufferTimeSignature

  • __call(bufferTimeSpan: number, bufferCreationInterval?: number, scheduler?: Scheduler): Observable<T[]>

  • Parameters

    • bufferTimeSpan: number
    • Optional bufferCreationInterval: number
    • Optional scheduler: Scheduler

    Returns Observable<T[]>

DispatchArg

DispatchArg:

buffer

buffer: Array<T>

subscriber

subscriber: BufferTimeSubscriber<T>

CreationState

CreationState: object

Type declaration

bufferTime

  • bufferTime<T>(bufferTimeSpan: number, bufferCreationInterval?: number, scheduler?: Scheduler): Observable<T[]>

  • Buffers the source Observable values for a specific time period.

    Collects values from the past as an array, and emits those arrays periodically in time.

    Buffers values from the source for a specific time duration bufferTimeSpan. Unless the optional argument bufferCreationInterval is given, it emits and resets the buffer every bufferTimeSpan milliseconds. If bufferCreationInterval is given, this operator opens the buffer every bufferCreationInterval milliseconds and closes (emits and resets) the buffer every bufferTimeSpan milliseconds.

    example

    Every second, emit an array of the recent click events var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferTime(1000); buffered.subscribe(x => console.log(x));

    example

    Every 5 seconds, emit the click events from the next 2 seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferTime(2000, 5000); buffered.subscribe(x => console.log(x));

    see

    buffer

    see

    bufferCount

    see

    bufferToggle

    see

    bufferWhen

    see

    {@link windowTime}

    method

    bufferTime

    owner

    Observable

    Type parameters

    • T

    Parameters

    • bufferTimeSpan: number

      The amount of time to fill each buffer array.

    • Default value bufferCreationInterval: number = null
    • Default value scheduler: Scheduler = async

    Returns Observable<T[]>

    An observable of arrays of buffered values.

dispatchBufferClose

  • Type parameters

    • T

    Parameters

    Returns void

dispatchBufferCreation

  • Type parameters

    • T

    Parameters

    Returns void

dispatchBufferTimeSpanOnly

  • dispatchBufferTimeSpanOnly(state: any): void

  • Parameters

    • state: any

    Returns void

"node_modules/rxjs/src/operator/bufferToggle"

"node_modules/rxjs/src/operator/bufferToggle":

BufferToggleOperator

BufferToggleOperator:

constructor

closingSelector

closingSelector: function

Type declaration

openings

openings: SubscribableOrPromise

call

  • call(subscriber: Subscriber<T[]>, source: any): any

  • Parameters

    Returns any

BufferToggleSubscriber

BufferToggleSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

closingSelector

closingSelector: function

Type declaration

contexts

contexts: Array<BufferContext<T>>

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

openings

openings: SubscribableOrPromise

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

closeBuffer

  • Parameters

    Returns void

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: any, innerValue: O, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, O>): void

  • Parameters

    • outerValue: any
    • innerValue: O
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, O>

    Returns void

openBuffer

  • openBuffer(value: O): void

  • Parameters

    • value: O

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

trySubscribe

  • trySubscribe(closingNotifier: any): void

  • Parameters

    • closingNotifier: any

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

BufferContext

BufferContext:

buffer

buffer: T[]

subscription

subscription: Subscription

BufferToggleSignature

bufferToggle

  • Buffers the source Observable values starting from an emission from openings and ending when the output of closingSelector emits.

    Collects values from the past as an array. Starts collecting only when opening emits, and calls the closingSelector function to get an Observable that tells when to close the buffer.

    Buffers values from the source by opening the buffer via signals from an Observable provided to openings, and closing and sending the buffers when a Subscribable or Promise returned by the closingSelector function emits.

    example

    Every other second, emit the click events from the next 500ms var clicks = Rx.Observable.fromEvent(document, 'click'); var openings = Rx.Observable.interval(1000); var buffered = clicks.bufferToggle(openings, i => i % 2 ? Rx.Observable.interval(500) : Rx.Observable.empty() ); buffered.subscribe(x => console.log(x));

    see

    buffer

    see

    bufferCount

    see

    bufferTime

    see

    bufferWhen

    see

    windowToggle

    method

    bufferToggle

    owner

    Observable

    Type parameters

    • T

    • O

    Parameters

    • openings: SubscribableOrPromise

      A Subscribable or Promise of notifications to start new buffers.

    • closingSelector: function

      A function that takes the value emitted by the openings observable and returns a Subscribable or Promise, which, when it emits, signals that the associated buffer should be emitted and cleared.

    Returns Observable<T[]>

    An observable of arrays of buffered values.

"node_modules/rxjs/src/operator/bufferWhen"

"node_modules/rxjs/src/operator/bufferWhen":

BufferWhenOperator

BufferWhenOperator:

constructor

closingSelector

closingSelector: function

Type declaration

call

  • call(subscriber: Subscriber<T[]>, source: any): any

  • Parameters

    Returns any

BufferWhenSubscriber

BufferWhenSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

buffer

buffer: T[]

closingSelector

closingSelector: function

Type declaration

closingSubscription

closingSubscription: Subscription

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

subscribing

subscribing: boolean

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

  • notifyComplete(): void

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, any>): void

  • Parameters

    • outerValue: T
    • innerValue: any
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, any>

    Returns void

openBuffer

  • openBuffer(): void

  • Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

BufferWhenSignature

  • __call(closingSelector: function): Observable<T[]>

  • Parameters

    Returns Observable<T[]>

bufferWhen

  • bufferWhen<T>(closingSelector: function): Observable<T[]>

  • Buffers the source Observable values, using a factory function of closing Observables to determine when to close, emit, and reset the buffer.

    Collects values from the past as an array. When it starts collecting values, it calls a function that returns an Observable that tells when to close the buffer and restart collecting.

    Opens a buffer immediately, then closes the buffer when the observable returned by calling closingSelector function emits a value. When it closes the buffer, it immediately opens a new buffer and repeats the process.

    example

    Emit an array of the last clicks every [1-5] random seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferWhen(() => Rx.Observable.interval(1000 + Math.random() * 4000) ); buffered.subscribe(x => console.log(x));

    see

    buffer

    see

    bufferCount

    see

    bufferTime

    see

    bufferToggle

    see

    windowWhen

    method

    bufferWhen

    owner

    Observable

    Type parameters

    • T

    Parameters

    • closingSelector: function

      A function that takes no arguments and returns an Observable that signals buffer closure.

    Returns Observable<T[]>

    An observable of arrays of buffered values.

"node_modules/rxjs/src/operator/cache"

"node_modules/rxjs/src/operator/cache":

CacheSignature

  • Parameters

    • Optional bufferSize: number
    • Optional windowTime: number
    • Optional scheduler: Scheduler

    Returns Observable<T>

cache

  • method

    cache

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Default value bufferSize: number = Number.POSITIVE_INFINITY
    • Default value windowTime: number = Number.POSITIVE_INFINITY
    • Optional scheduler: Scheduler

    Returns Observable<T>

"node_modules/rxjs/src/operator/catch"

"node_modules/rxjs/src/operator/catch":

CatchOperator

CatchOperator:

constructor

caught

caught: Observable<any>

selector

selector: function

Type declaration

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

CatchSubscriber

CatchSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

caught

caught: Observable<any>

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

selector

selector: function

Type declaration

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_innerSub

  • Parameters

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err: any): void

  • Parameters

    • err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

CatchSignature

_catch

  • Catches errors on the observable to be handled by returning a new observable or throwing an error.

    method

    catch

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    • selector: function

      a function that takes as arguments err, which is the error, and caught, which is the source observable, in case you'd like to "retry" that observable by returning it again. Whatever observable is returned by the selector will be used to continue the observable chain.

    Returns Observable<R>

    an observable that originates from either the source or the observable returned by the catch selector function.

"node_modules/rxjs/src/operator/combineAll"

"node_modules/rxjs/src/operator/combineAll":

CombineAllSignature

  • Returns Observable<T[]>

  • Type parameters

    • R

    Parameters

    • Optional project: function
        • (...values: Array<T>): R

        • Parameters

          • Rest ...values: Array<T>

          Returns R

    Returns Observable<R>

combineAll

  • combineAll<R>(project?: function): Observable<R>

  • Converts a higher-order Observable into a first-order Observable by waiting for the outer Observable to complete, then applying combineLatest.

    Flattens an Observable-of-Observables by applying combineLatest when the Observable-of-Observables completes.

    Takes an Observable of Observables, and collects all Observables from it. Once the outer Observable completes, it subscribes to all collected Observables and combines their values using the combineLatest strategy, such that:

    • Every time an inner Observable emits, the output Observable emits.
    • When the returned observable emits, it emits all of the latest values by:
      • If a project function is provided, it is called with each recent value from each inner Observable in whatever order they arrived, and the result of the project function is what is emitted by the output Observable.
      • If there is no project function, an array of all of the most recent values is emitted by the output Observable.
    example

    Map two click events to a finite interval Observable, then apply combineAll var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map(ev => Rx.Observable.interval(Math.random()*2000).take(3) ).take(2); var result = higherOrder.combineAll(); result.subscribe(x => console.log(x));

    see

    combineLatest

    see

    mergeAll

    method

    combineAll

    owner

    Observable

    Type parameters

    • R

    Parameters

    • Optional project: function
        • (...values: Array<any>): R

        • Parameters

          • Rest ...values: Array<any>

          Returns R

    Returns Observable<R>

    An Observable of projected results or arrays of recent values.

"node_modules/rxjs/src/operator/combineLatest"

"node_modules/rxjs/src/operator/combineLatest":

CombineLatestOperator

CombineLatestOperator:

constructor

  • Parameters

    • Optional project: function
        • (...values: Array<any>): R

        • Parameters

          • Rest ...values: Array<any>

          Returns R

    Returns CombineLatestOperator

project

project: function

Type declaration

    • (...values: Array<any>): R

    • Parameters

      • Rest ...values: Array<any>

      Returns R

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

CombineLatestSubscriber

CombineLatestSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<R>
    • Optional project: function
        • (...values: Array<any>): R

        • Parameters

          • Rest ...values: Array<any>

          Returns R

    Returns CombineLatestSubscriber

active

active: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

observables

observables: any[]

project

project: function

Type declaration

    • (...values: Array<any>): R

    • Parameters

      • Rest ...values: Array<any>

      Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

toRespond

toRespond: number[]

values

values: any[]

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(observable: any): void

  • Parameters

    • observable: any

    Returns void

_tryProject

  • _tryProject(values: any[]): void

  • Parameters

    • values: any[]

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

CombineLatestSignature

combineLatest

  • Combines multiple Observables to create an Observable whose values are calculated from the latest values of each of its input Observables.

    Whenever any input Observable emits a value, it computes a formula using the latest values from all the inputs, then emits the output of that formula.

    combineLatest combines the values from this Observable with values from Observables passed as arguments. This is done by subscribing to each Observable, in order, and collecting an array of each of the most recent values any time any of the input Observables emits, then either taking that array and passing it as arguments to an optional project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    example

    Dynamically calculate the Body-Mass Index from an Observable of weight and one for height var weight = Rx.Observable.of(70, 72, 76, 79, 75); var height = Rx.Observable.of(1.76, 1.77, 1.78); var bmi = weight.combineLatest(height, (w, h) => w / (h * h)); bmi.subscribe(x => console.log('BMI is ' + x));

    see

    combineAll

    see

    merge

    see

    withLatestFrom

    method

    combineLatest

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    Returns Observable<R>

    An Observable of projected values from the most recent values from each input Observable, or an array of the most recent values from each input Observable.

combineLatestStatic

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • T

    Parameters

    Returns Observable<[T]>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • T

    • T2

    Parameters

    Returns Observable<[T, T2]>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • T

    • T2

    • T3

    Parameters

    Returns Observable<[T, T2, T3]>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • T

    • T2

    • T3

    • T4

    Parameters

    Returns Observable<[T, T2, T3, T4]>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    Parameters

    Returns Observable<[T, T2, T3, T4, T5]>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    Returns Observable<[T, T2, T3, T4, T5, T6]>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • T

    • R

    Parameters

    Returns Observable<R>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • T

    • T2

    • R

    Parameters

    Returns Observable<R>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • T

    • T2

    • T3

    • R

    Parameters

    Returns Observable<R>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • R

    Parameters

    Returns Observable<R>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    • R

    Parameters

    Returns Observable<R>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    • T6

    • R

    Parameters

    Returns Observable<R>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • R

    Parameters

    Returns Observable<R>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • R

    Parameters

    Returns Observable<R>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

  • Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

    Type parameters

    • R

    Parameters

    • array: ObservableInput[]
    • project: function
        • (...values: Array<any>): R

        • Parameters

          • Rest ...values: Array<any>

          Returns R

    • Optional scheduler: Scheduler

    Returns Observable<R>

    an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

"node_modules/rxjs/src/operator/concat"

"node_modules/rxjs/src/operator/concat":

ConcatSignature

concat

  • Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

    Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

    Joins this Observable with multiple other Observables by subscribing to them one at a time, starting with the source, and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

    example

    Concatenate a timer counting from 0 to 3 with a synchronous sequence from 1 to 10 var timer = Rx.Observable.interval(1000).take(4); var sequence = Rx.Observable.range(1, 10); var result = timer.concat(sequence); result.subscribe(x => console.log(x));

    example

    Concatenate 3 Observables var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var result = timer1.concat(timer2, timer3); result.subscribe(x => console.log(x));

    see

    concatAll

    see

    concatMap

    see

    concatMapTo

    method

    concat

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    Returns Observable<R>

    All values of each passed Observable merged into a single Observable, in order, in serial fashion.

concatStatic

  • Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

    Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

    Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    All values of each passed Observable merged into a single Observable, in order, in serial fashion.

  • Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

    Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

    Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

    Type parameters

    • T

    • T2

    Parameters

    Returns Observable<T | T2>

    All values of each passed Observable merged into a single Observable, in order, in serial fashion.

  • Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

    Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

    Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

    Type parameters

    • T

    • T2

    • T3

    Parameters

    Returns Observable<T | T2 | T3>

    All values of each passed Observable merged into a single Observable, in order, in serial fashion.

  • Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

    Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

    Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

    Type parameters

    • T

    • T2

    • T3

    • T4

    Parameters

    Returns Observable<T | T2 | T3 | T4>

    All values of each passed Observable merged into a single Observable, in order, in serial fashion.

  • Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

    Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

    Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    Parameters

    Returns Observable<T | T2 | T3 | T4 | T5>

    All values of each passed Observable merged into a single Observable, in order, in serial fashion.

  • Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

    Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

    Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    Returns Observable<T | T2 | T3 | T4 | T5 | T6>

    All values of each passed Observable merged into a single Observable, in order, in serial fashion.

  • Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

    Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

    Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    All values of each passed Observable merged into a single Observable, in order, in serial fashion.

  • Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

    Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

    Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

    Type parameters

    • T

    • R

    Parameters

    Returns Observable<R>

    All values of each passed Observable merged into a single Observable, in order, in serial fashion.

"node_modules/rxjs/src/operator/concatAll"

"node_modules/rxjs/src/operator/concatAll":

ConcatAllSignature

  • Returns T

  • Type parameters

    • R

    Returns Subscribable<R>

concatAll

  • concatAll<T>(): T

  • Converts a higher-order Observable into a first-order Observable by concatenating the inner Observables in order.

    Flattens an Observable-of-Observables by putting one inner Observable after the other.

    Joins every Observable emitted by the source (a higher-order Observable), in a serial fashion. It subscribes to each inner Observable only after the previous inner Observable has completed, and merges all of their values into the returned observable.

    Warning: If the source Observable emits Observables quickly and endlessly, and the inner Observables it emits generally complete slower than the source emits, you can run into memory issues as the incoming Observables collect in an unbounded buffer.

    Note: concatAll is equivalent to mergeAll with concurrency parameter set to 1.

    example

    For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map(ev => Rx.Observable.interval(1000).take(4)); var firstOrder = higherOrder.concatAll(); firstOrder.subscribe(x => console.log(x));

    see

    combineAll

    see

    concat

    see

    concatMap

    see

    concatMapTo

    see

    exhaust

    see

    mergeAll

    see

    switch

    see

    zipAll

    method

    concatAll

    owner

    Observable

    Type parameters

    • T

    Returns T

    An Observable emitting values from all the inner Observables concatenated.

"node_modules/rxjs/src/operator/concatMap"

"node_modules/rxjs/src/operator/concatMap":

ConcatMapSignature

  • __call<R>(project: function): Observable<R>
  • __call<I, R>(project: function, resultSelector: function): Observable<R>

  • Type parameters

    • R

    Parameters

    Returns Observable<R>

  • Type parameters

    • I

    • R

    Parameters

    • project: function
    • resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns Observable<R>

concatMap

  • concatMap<T, I, R>(project: function, resultSelector?: function): any

  • Projects each source value to an Observable which is merged in the output Observable, in a serialized fashion waiting for each one to complete before merging the next.

    Maps each value to an Observable, then flattens all of these inner Observables using concatAll.

    Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each new inner Observable is concatenated with the previous inner Observable.

    Warning: if source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

    Note: concatMap is equivalent to mergeMap with concurrency parameter set to 1.

    example

    For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.concatMap(ev => Rx.Observable.interval(1000).take(4)); result.subscribe(x => console.log(x));

    see

    concat

    see

    concatAll

    see

    concatMapTo

    see

    exhaustMap

    see

    mergeMap

    see

    switchMap

    method

    concatMap

    owner

    Observable

    Type parameters

    • T

    • I

    • R

    Parameters

    • project: function

      A function that, when applied to an item emitted by the source Observable, returns an Observable.

    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns any

    an observable of values merged from the projected Observables as they were subscribed to, one at a time. Optionally, these values may have been projected from a passed projectResult argument.

"node_modules/rxjs/src/operator/concatMapTo"

"node_modules/rxjs/src/operator/concatMapTo":

ConcatMapToSignature

  • Type parameters

    • R

    Parameters

    Returns Observable<R>

  • Type parameters

    • I

    • R

    Parameters

    • observable: ObservableInput
    • resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns Observable<R>

concatMapTo

  • Projects each source value to the same Observable which is merged multiple times in a serialized fashion on the output Observable.

    It's like concatMap, but maps each value always to the same inner Observable.

    Maps each source value to the given Observable innerObservable regardless of the source value, and then flattens those resulting Observables into one single Observable, which is the output Observable. Each new innerObservable instance emitted on the output Observable is concatenated with the previous innerObservable instance.

    Warning: if source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

    Note: concatMapTo is equivalent to mergeMapTo with concurrency parameter set to 1.

    example

    For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.concatMapTo(Rx.Observable.interval(1000).take(4)); result.subscribe(x => console.log(x));

    see

    concat

    see

    concatAll

    see

    concatMap

    see

    mergeMapTo

    see

    switchMapTo

    method

    concatMapTo

    owner

    Observable

    Type parameters

    • T

    • I

    • R

    Parameters

    • innerObservable: Observable<I>

      An Observable to replace each value from the source Observable.

    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns Observable<R>

    An observable of values merged together by joining the passed observable with itself, one after the other, for each value emitted from the source.

"node_modules/rxjs/src/operator/count"

"node_modules/rxjs/src/operator/count":

CountOperator

CountOperator:

constructor

  • Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional source: Observable<T>

    Returns CountOperator

predicate

predicate: function

Type declaration

    • (value: T, index: number, source: Observable<T>): boolean

    • Parameters

      Returns boolean

source

source: Observable<T>

call

  • call(subscriber: Subscriber<number>, source: any): any

  • Parameters

    Returns any

CountSubscriber

CountSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

count

count: number

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

predicate

predicate: function

Type declaration

    • (value: T, index: number, source: Observable<T>): boolean

    • Parameters

      Returns boolean

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_tryPredicate

  • _tryPredicate(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

CountSignature

  • __call(predicate?: function): Observable<number>

  • Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    Returns Observable<number>

count

  • count<T>(predicate?: function): Observable<number>

  • Counts the number of emissions on the source and emits that number when the source completes.

    Tells how many values were emitted, when the source completes.

    count transforms an Observable that emits values into an Observable that emits a single value that represents the number of values emitted by the source Observable. If the source Observable terminates with an error, count will pass this error notification along without emitting an value first. If the source Observable does not terminate at all, count will neither emit a value nor terminate. This operator takes an optional predicate function as argument, in which case the output emission will represent the number of source values that matched true with the predicate.

    example

    Counts how many seconds have passed before the first click happened var seconds = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var secondsBeforeClick = seconds.takeUntil(clicks); var result = secondsBeforeClick.count(); result.subscribe(x => console.log(x));

    example

    Counts how many odd numbers are there between 1 and 7 var numbers = Rx.Observable.range(1, 7); var result = numbers.count(i => i % 2 === 1); result.subscribe(x => console.log(x));

    see

    max

    see

    {@link min}

    see

    reduce

    method

    count

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    Returns Observable<number>

    An Observable of one number that represents the count as described above.

"node_modules/rxjs/src/operator/debounce"

"node_modules/rxjs/src/operator/debounce":

DebounceOperator

DebounceOperator:

constructor

durationSelector

durationSelector: function

Type declaration

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

DebounceSubscriber

DebounceSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

durationSelector

durationSelector: function

Type declaration

durationSubscription

durationSubscription: Subscription

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

value

value: T

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_tryNext

  • Parameters

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

emitValue

  • emitValue(): void

  • Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

  • notifyComplete(): void

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DebounceSignature

  • __call(durationSelector: function): Observable<T>

debounce

  • debounce<T>(durationSelector: function): Observable<T>

  • Returns the source Observable delayed by the computed debounce duration, with the duration lengthened if a new source item arrives before the delay duration ends. In practice, for each item emitted on the source, this operator holds the latest item, waits for a silence as long as the durationSelector specifies, and only then emits the latest source item on the result Observable.

    method

    debounce

    owner

    Observable

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    an Observable the same as source Observable, but drops items.

"node_modules/rxjs/src/operator/debounceTime"

"node_modules/rxjs/src/operator/debounceTime":

DebounceTimeOperator

DebounceTimeOperator:

constructor

dueTime

dueTime: number

scheduler

scheduler: Scheduler

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

DebounceTimeSubscriber

DebounceTimeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

debouncedSubscription

debouncedSubscription: Subscription

destination

destination: PartialObserver

dueTime

dueTime: number

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

lastValue

lastValue: T

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

clearDebounce

  • clearDebounce(): void

  • Returns void

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

debouncedNext

  • debouncedNext(): void

  • Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DebounceTimeSignature

  • Parameters

    • dueTime: number
    • Optional scheduler: Scheduler

    Returns Observable<T>

debounceTime

  • Returns the source Observable delayed by the computed debounce duration, with the duration lengthened if a new source item arrives before the delay duration ends. In practice, for each item emitted on the source, this operator holds the latest item, waits for a silence for the dueTime length, and only then emits the latest source item on the result Observable. Optionally takes a scheduler for manging timers.

    method

    debounceTime

    owner

    Observable

    Type parameters

    • T

    Parameters

    • dueTime: number

      the timeout value for the window of time required to not drop the item.

    • Default value scheduler: Scheduler = async

    Returns Observable<T>

    an Observable the same as source Observable, but drops items.

dispatchNext

  • Parameters

    Returns void

"node_modules/rxjs/src/operator/defaultIfEmpty"

"node_modules/rxjs/src/operator/defaultIfEmpty":

DefaultIfEmptyOperator

DefaultIfEmptyOperator:

constructor

  • Parameters

    • defaultValue: R

    Returns DefaultIfEmptyOperator

defaultValue

defaultValue: R

call

  • call(subscriber: Subscriber<T | R>, source: any): any

  • Parameters

    Returns any

DefaultIfEmptySubscriber

DefaultIfEmptySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

defaultValue

defaultValue: R

destination

destination: PartialObserver

isEmpty

isEmpty: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DefaultIfEmptySignature

  • Parameters

    • Optional defaultValue: T

    Returns Observable<T>

  • Type parameters

    • R

    Parameters

    • Optional defaultValue: R

    Returns Observable<T | R>

defaultIfEmpty

  • defaultIfEmpty<T, R>(defaultValue?: R): Observable<T | R>

  • Returns an Observable that emits the elements of the source or a specified default value if empty.

    method

    defaultIfEmpty

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    • Default value defaultValue: R = null

      the default value used if source is empty; defaults to null.

    Returns Observable<T | R>

    an Observable of the items emitted by the where empty values are replaced by the specified default value or null.

"node_modules/rxjs/src/operator/delay"

"node_modules/rxjs/src/operator/delay":

DelayMessage

DelayMessage:

constructor

  • new DelayMessage(time: number, notification: any): DelayMessage

  • Parameters

    • time: number
    • notification: any

    Returns DelayMessage

notification

notification: any

time

time: number

DelayOperator

DelayOperator:

constructor

  • Parameters

    Returns DelayOperator

delay

delay: number

scheduler

scheduler: Scheduler

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

DelaySubscriber

DelaySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

active

active: boolean

delay

delay: number

destination

destination: PartialObserver

errored

errored: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

queue

queue: Array<any>

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_schedule

  • Parameters

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

scheduleNotification

  • scheduleNotification(notification: Notification<any>): void

  • Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

dispatch

  • dispatch(state: any): void

  • Parameters

    • state: any

    Returns void

DelaySignature

  • Parameters

    • delay: number | Date
    • Optional scheduler: Scheduler

    Returns Observable<T>

delay

  • Delays the emission of items from the source Observable by a given timeout or until a given Date.

    Time shifts each item by some specified amount of milliseconds.

    If the delay argument is a Number, this operator time shifts the source Observable by that amount of time expressed in milliseconds. The relative time intervals between the values are preserved.

    If the delay argument is a Date, this operator time shifts the start of the Observable execution until the given date occurs.

    example

    Delay each click by one second var clicks = Rx.Observable.fromEvent(document, 'click'); var delayedClicks = clicks.delay(1000); // each click emitted after 1 second delayedClicks.subscribe(x => console.log(x));

    example

    Delay all clicks until a future date happens var clicks = Rx.Observable.fromEvent(document, 'click'); var date = new Date('March 15, 2050 12:00:00'); // in the future var delayedClicks = clicks.delay(date); // click emitted only after that date delayedClicks.subscribe(x => console.log(x));

    see

    debounceTime

    see

    delayWhen

    method

    delay

    owner

    Observable

    Type parameters

    • T

    Parameters

    • delay: number | Date

      The delay duration in milliseconds (a number) or a Date until which the emission of the source items is delayed.

    • Default value scheduler: Scheduler = async

    Returns Observable<T>

    An Observable that delays the emissions of the source Observable by the specified timeout or Date.

"node_modules/rxjs/src/operator/delayWhen"

"node_modules/rxjs/src/operator/delayWhen":

DelayWhenOperator

DelayWhenOperator:

constructor

  • Parameters

    • delayDurationSelector: function

    Returns DelayWhenOperator

delayDurationSelector

delayDurationSelector: function

Type declaration

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

DelayWhenSubscriber

DelayWhenSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

completed

completed: boolean

delayDurationSelector

delayDurationSelector: function

Type declaration

delayNotifierSubscriptions

delayNotifierSubscriptions: Array<Subscription>

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

values

values: Array<T>

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: any
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

removeSubscription

  • Parameters

    Returns T

tryComplete

  • tryComplete(): void

  • Returns void

tryDelay

  • tryDelay(delayNotifier: Observable<any>, value: T): void

  • Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SubscriptionDelayObservable

SubscriptionDelayObservable:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

source

source: Observable<T>

subscriptionDelay

subscriptionDelay: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates a new cold Observable by calling the Observable constructor

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    a new cold observable

SubscriptionDelaySubscriber

SubscriptionDelaySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

parent

parent: Subscriber<T>

source

source: Observable<T>

sourceSubscribed

sourceSubscribed: boolean

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(unused: any): void

  • Parameters

    • unused: any

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

subscribeToSource

  • subscribeToSource(): void

  • Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DelayWhenSignature

  • Parameters

    Returns Observable<T>

delayWhen

  • Returns an Observable that delays the emission of items from the source Observable by a subscription delay and a delay selector function for each element.

    method

    delayWhen

    owner

    Observable

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    an Observable that delays the emissions of the source Observable by the specified timeout or Date.

"node_modules/rxjs/src/operator/dematerialize"

"node_modules/rxjs/src/operator/dematerialize":

DeMaterializeOperator

DeMaterializeOperator:

call

  • call(subscriber: Subscriber<any>, source: any): any

  • Parameters

    Returns any

DeMaterializeSubscriber

DeMaterializeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DematerializeSignature

  • Type parameters

    • R

    Returns Observable<R>

dematerialize

  • Returns an Observable that transforms Notification objects into the items or notifications they represent.

    see

    Notification

    method

    dematerialize

    owner

    Observable

    Type parameters

    • T

    Returns Observable<any>

    an Observable that emits items and notifications embedded in Notification objects emitted by the source Observable.

"node_modules/rxjs/src/operator/distinct"

"node_modules/rxjs/src/operator/distinct":

DistinctOperator

DistinctOperator:

constructor

  • Parameters

    • compare: function
        • (x: T, y: T): boolean

        • Parameters

          • x: T
          • y: T

          Returns boolean

    • flushes: Observable<any>

    Returns DistinctOperator

compare

compare: function

Type declaration

    • (x: T, y: T): boolean

    • Parameters

      • x: T
      • y: T

      Returns boolean

flushes

flushes: Observable<any>

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

DistinctSubscriber

DistinctSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

values

values: Array<T>

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

compare

  • compare(x: T, y: T): boolean

  • Parameters

    • x: T
    • y: T

    Returns boolean

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

  • Parameters

    • outerValue: T
    • innerValue: T
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, T>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DistinctSignature

  • Parameters

    • Optional compare: function
        • (x: T, y: T): boolean

        • Parameters

          • x: T
          • y: T

          Returns boolean

    • Optional flushes: Observable<any>

    Returns Observable<T>

distinct

  • Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from previous items. If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted. If a comparator function is not provided, an equality check is used by default. As the internal HashSet of this operator grows larger and larger, care should be taken in the domain of inputs this operator may see. An optional parameter is also provided such that an Observable can be provided to queue the internal HashSet to flush the values it holds.

    method

    distinct

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Optional compare: function
        • (x: T, y: T): boolean

        • Parameters

          • x: T
          • y: T

          Returns boolean

    • Optional flushes: Observable<any>

    Returns Observable<T>

    an Observable that emits items from the source Observable with distinct values.

"node_modules/rxjs/src/operator/distinctKey"

"node_modules/rxjs/src/operator/distinctKey":

DistinctKeySignature

  • Parameters

    • key: string

    Returns Observable<T>

  • Type parameters

    • K

    Parameters

    • key: string
    • compare: function
        • (x: K, y: K): boolean

        • Parameters

          • x: K
          • y: K

          Returns boolean

    • Optional flushes: Observable<any>

    Returns Observable<T>

distinctKey

  • Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from previous items, using a property accessed by using the key provided to check if the two items are distinct. If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted. If a comparator function is not provided, an equality check is used by default. As the internal HashSet of this operator grows larger and larger, care should be taken in the domain of inputs this operator may see. An optional parameter is also provided such that an Observable can be provided to queue the internal HashSet to flush the values it holds.

    method

    distinctKey

    owner

    Observable

    Type parameters

    • T

    Parameters

    • key: string

      string key for object property lookup on each item.

    • Optional compare: function
        • (x: T, y: T): boolean

        • Parameters

          • x: T
          • y: T

          Returns boolean

    • Optional flushes: Observable<any>

    Returns Observable<T>

    an Observable that emits items from the source Observable with distinct values.

"node_modules/rxjs/src/operator/distinctUntilChanged"

"node_modules/rxjs/src/operator/distinctUntilChanged":

DistinctUntilChangedOperator

DistinctUntilChangedOperator:

constructor

  • Parameters

    • compare: function
        • (x: K, y: K): boolean

        • Parameters

          • x: K
          • y: K

          Returns boolean

    • keySelector: function
        • (x: T): K

        • Parameters

          • x: T

          Returns K

    Returns DistinctUntilChangedOperator

compare

compare: function

Type declaration

    • (x: K, y: K): boolean

    • Parameters

      • x: K
      • y: K

      Returns boolean

keySelector

keySelector: function

Type declaration

    • (x: T): K

    • Parameters

      • x: T

      Returns K

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

DistinctUntilChangedSubscriber

DistinctUntilChangedSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<T>
    • compare: function
        • (x: K, y: K): boolean

        • Parameters

          • x: K
          • y: K

          Returns boolean

    • keySelector: function
        • (x: T): K

        • Parameters

          • x: T

          Returns K

    Returns DistinctUntilChangedSubscriber

destination

destination: PartialObserver

hasKey

hasKey: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

key

key: K

keySelector

keySelector: function

Type declaration

    • (x: T): K

    • Parameters

      • x: T

      Returns K

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

compare

  • compare(x: any, y: any): boolean

  • Parameters

    • x: any
    • y: any

    Returns boolean

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DistinctUntilChangedSignature

  • __call(compare?: function): Observable<T>
  • __call<K>(compare: function, keySelector: function): Observable<T>

  • Parameters

    • Optional compare: function
        • (x: T, y: T): boolean

        • Parameters

          • x: T
          • y: T

          Returns boolean

    Returns Observable<T>

  • Type parameters

    • K

    Parameters

    • compare: function
        • (x: K, y: K): boolean

        • Parameters

          • x: K
          • y: K

          Returns boolean

    • keySelector: function
        • (x: T): K

        • Parameters

          • x: T

          Returns K

    Returns Observable<T>

distinctUntilChanged

  • distinctUntilChanged<T, K>(compare?: function, keySelector?: function): Observable<T>

  • Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item. If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted. If a comparator function is not provided, an equality check is used by default.

    method

    distinctUntilChanged

    owner

    Observable

    Type parameters

    • T

    • K

    Parameters

    • Optional compare: function
        • (x: K, y: K): boolean

        • Parameters

          • x: K
          • y: K

          Returns boolean

    • Optional keySelector: function
        • (x: T): K

        • Parameters

          • x: T

          Returns K

    Returns Observable<T>

    an Observable that emits items from the source Observable with distinct values.

"node_modules/rxjs/src/operator/distinctUntilKeyChanged"

"node_modules/rxjs/src/operator/distinctUntilKeyChanged":

DistinctUntilKeyChangedSignature

  • Parameters

    • key: string

    Returns Observable<T>

  • Type parameters

    • K

    Parameters

    • key: string
    • compare: function
        • (x: K, y: K): boolean

        • Parameters

          • x: K
          • y: K

          Returns boolean

    Returns Observable<T>

distinctUntilKeyChanged

  • distinctUntilKeyChanged<T>(key: string, compare?: function): Observable<T>

  • Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item, using a property accessed by using the key provided to check if the two items are distinct. If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted. If a comparator function is not provided, an equality check is used by default.

    method

    distinctUntilKeyChanged

    owner

    Observable

    Type parameters

    • T

    Parameters

    • key: string

      string key for object property lookup on each item.

    • Optional compare: function
        • (x: T, y: T): boolean

        • Parameters

          • x: T
          • y: T

          Returns boolean

    Returns Observable<T>

    an Observable that emits items from the source Observable with distinct values based on the key specified.

"node_modules/rxjs/src/operator/do"

"node_modules/rxjs/src/operator/do":

DoOperator

DoOperator:

constructor

  • Parameters

    • Optional nextOrObserver: PartialObserver | function
    • Optional error: function
        • (e: any): void

        • Parameters

          • e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns DoOperator

complete

complete: function

Type declaration

    • (): void

    • Returns void

error

error: function

Type declaration

    • (e: any): void

    • Parameters

      • e: any

      Returns void

nextOrObserver

nextOrObserver: PartialObserver | function

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

DoSubscriber

DoSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<T>
    • Optional nextOrObserver: PartialObserver | function
    • Optional error: function
        • (e: any): void

        • Parameters

          • e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns DoSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

safeSubscriber

safeSubscriber: Subscriber<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DoSignature

  • Parameters

    • next: function
        • (x: T): void

        • Parameters

          • x: T

          Returns void

    • Optional error: function
        • (e: any): void

        • Parameters

          • e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Observable<T>

  • Parameters

    Returns Observable<T>

_do

  • Perform a side effect for every emission on the source Observable, but return an Observable that is identical to the source.

    Intercepts each emission on the source and runs a function, but returns an output which is identical to the source.

    Returns a mirrored Observable of the source Observable, but modified so that the provided Observer is called to perform a side effect for every value, error, and completion emitted by the source. Any errors that are thrown in the aforementioned Observer or handlers are safely sent down the error path of the output Observable.

    This operator is useful for debugging your Observables for the correct values or performing other side effects.

    Note: this is different to a subscribe on the Observable. If the Observable returned by do is not subscribed, the side effects specified by the Observer will never happen. do therefore simply spies on existing execution, it does not trigger an execution to happen like subscribe does.

    example

    Map every every click to the clientX position of that click, while also logging the click event var clicks = Rx.Observable.fromEvent(document, 'click'); var positions = clicks .do(ev => console.log(ev)) .map(ev => ev.clientX); positions.subscribe(x => console.log(x));

    see

    {@link map}

    see

    subscribe

    method

    do

    name

    do

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Optional nextOrObserver: PartialObserver | function
    • Optional error: function
        • (e: any): void

        • Parameters

          • e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Observable<T>

    An Observable identical to the source, but runs the specified Observer or callback(s) for each item.

"node_modules/rxjs/src/operator/elementAt"

"node_modules/rxjs/src/operator/elementAt":

ElementAtOperator

ElementAtOperator:

constructor

  • Parameters

    • index: number
    • Optional defaultValue: T

    Returns ElementAtOperator

defaultValue

defaultValue: T

index

index: number

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

ElementAtSubscriber

ElementAtSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

defaultValue

defaultValue: T

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(x: T): void

  • Parameters

    • x: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

ElementAtSignature

  • __call(index: number, defaultValue?: T): Observable<T>

  • Parameters

    • index: number
    • Optional defaultValue: T

    Returns Observable<T>

elementAt

  • elementAt<T>(index: number, defaultValue?: T): Observable<T>

  • Returns an Observable that emits the item at the specified index in the source Observable. If default is given, missing indices will output this value on next; otherwise, outputs error.

    throws

    {ArgumentOutOfRangeError} When using elementAt(i), it delivers an ArgumentOutOrRangeError to the Observer's error callback if i < 0 or the Observable has completed before emitting the i-th next notification.

    method

    elementAt

    owner

    Observable

    Type parameters

    • T

    Parameters

    • index: number

      the index of the value to be retrieved.

    • Optional defaultValue: T

    Returns Observable<T>

    an Observable that emits a single item, if it is found. Otherwise, will emit the default value if given.

"node_modules/rxjs/src/operator/every"

"node_modules/rxjs/src/operator/every":

EveryOperator

EveryOperator:

constructor

  • Parameters

    • predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional thisArg: any
    • Optional source: Observable<T>

    Returns EveryOperator

predicate

predicate: function

Type declaration

    • (value: T, index: number, source: Observable<T>): boolean

    • Parameters

      Returns boolean

source

source: Observable<T>

thisArg

thisArg: any

call

  • call(observer: Subscriber<boolean>, source: any): any

  • Parameters

    Returns any

EverySubscriber

EverySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

predicate

predicate: function

Type declaration

    • (value: T, index: number, source: Observable<T>): boolean

    • Parameters

      Returns boolean

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

thisArg

thisArg: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

  • notifyComplete(everyValueMatch: boolean): void

  • Parameters

    • everyValueMatch: boolean

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

EverySignature

  • __call(predicate: function, thisArg?: any): Observable<boolean>

  • Parameters

    • predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Observable<boolean>

every

  • every<T>(predicate: function, thisArg?: any): Observable<boolean>

  • Returns an Observable that emits whether or not every item of the source satisfies the condition specified.

    method

    every

    owner

    Observable

    Type parameters

    • T

    Parameters

    • predicate: function

      a function for determining if an item meets a specified condition.

        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Observable<boolean>

    an Observable of booleans that determines if all items of the source Observable meet the condition specified.

"node_modules/rxjs/src/operator/exhaust"

"node_modules/rxjs/src/operator/exhaust":

SwitchFirstOperator

SwitchFirstOperator:

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

SwitchFirstSubscriber

SwitchFirstSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

hasSubscription

hasSubscription: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

  • Parameters

    • outerValue: T
    • innerValue: T
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, T>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SwitchFirstSignature

  • __call(): T

  • Returns T

exhaust

  • Converts a higher-order Observable into a first-order Observable by dropping inner Observables while the previous inner Observable has not yet completed.

    Flattens an Observable-of-Observables by dropping the next inner Observables while the current inner is still executing.

    exhaust subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, the output Observable begins emitting the items emitted by that inner Observable. So far, it behaves like mergeAll. However, exhaust ignores every new inner Observable if the previous Observable has not yet completed. Once that one completes, it will accept and flatten the next inner Observable and repeat this process.

    example

    Run a finite timer for each click, only if there is no currently active timer var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000)); var result = higherOrder.exhaust(); result.subscribe(x => console.log(x));

    see

    combineAll

    see

    concatAll

    see

    switch

    see

    mergeAll

    see

    exhaustMap

    see

    zipAll

    method

    exhaust

    owner

    Observable

    Type parameters

    • T

    Returns Observable<T>

    Returns an Observable that takes a source of Observables and propagates the first observable exclusively until it completes before subscribing to the next.

"node_modules/rxjs/src/operator/exhaustMap"

"node_modules/rxjs/src/operator/exhaustMap":

SwitchFirstMapOperator

SwitchFirstMapOperator:

constructor

  • Parameters

    • project: function
    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns SwitchFirstMapOperator

project

project: function

Type declaration

resultSelector

resultSelector: function

Type declaration

    • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

    • Parameters

      • outerValue: T
      • innerValue: I
      • outerIndex: number
      • innerIndex: number

      Returns R

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

SwitchFirstMapSubscriber

SwitchFirstMapSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<R>
    • project: function
    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns SwitchFirstMapSubscriber

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

hasSubscription

hasSubscription: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

project

project: function

Type declaration

resultSelector

resultSelector: function

Type declaration

    • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

    • Parameters

      • outerValue: T
      • innerValue: I
      • outerIndex: number
      • innerIndex: number

      Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

  • notifyError(err: any): void

  • Parameters

    • err: any

    Returns void

notifyNext

  • notifyNext(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, I>): void

  • Parameters

    • outerValue: T
    • innerValue: I
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, I>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

tryNext

  • tryNext(value: T): void

  • Parameters

    • value: T

    Returns void

trySelectResult

  • trySelectResult(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): void

  • Parameters

    • outerValue: T
    • innerValue: I
    • outerIndex: number
    • innerIndex: number

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SwitchFirstMapSignature

  • __call<R>(project: function): Observable<R>
  • __call<I, R>(project: function, resultSelector: function): Observable<R>

  • Type parameters

    • R

    Parameters

    Returns Observable<R>

  • Type parameters

    • I

    • R

    Parameters

    • project: function
    • resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns Observable<R>

exhaustMap

  • exhaustMap<T, I, R>(project: function, resultSelector?: function): Observable<R>

  • Projects each source value to an Observable which is merged in the output Observable only if the previous projected Observable has completed.

    Maps each value to an Observable, then flattens all of these inner Observables using exhaust.

    Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. When it projects a source value to an Observable, the output Observable begins emitting the items emitted by that projected Observable. However, exhaustMap ignores every new projected Observable if the previous projected Observable has not yet completed. Once that one completes, it will accept and flatten the next projected Observable and repeat this process.

    example

    Run a finite timer for each click, only if there is no currently active timer var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.exhaustMap((ev) => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

    see

    concatMap

    see

    exhaust

    see

    mergeMap

    see

    switchMap

    method

    exhaustMap

    owner

    Observable

    Type parameters

    • T

    • I

    • R

    Parameters

    • project: function

      A function that, when applied to an item emitted by the source Observable, returns an Observable.

    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns Observable<R>

    An Observable containing projected Observables of each item of the source, ignoring projected Observables that start before their preceding Observable has completed.

"node_modules/rxjs/src/operator/expand"

"node_modules/rxjs/src/operator/expand":

ExpandOperator

ExpandOperator:

constructor

  • Parameters

    • project: function
    • concurrent: number
    • scheduler: Scheduler

    Returns ExpandOperator

concurrent

concurrent: number

project

project: function

Type declaration

scheduler

scheduler: Scheduler

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

ExpandSubscriber

ExpandSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

active

active: number

buffer

buffer: any[]

concurrent

concurrent: number

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

project

project: function

Type declaration

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: any): void

  • Parameters

    • value: any

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

subscribeToProjection

  • subscribeToProjection(result: any, value: T, index: number): void

  • Parameters

    • result: any
    • value: T
    • index: number

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

dispatch

  • Type parameters

    • T

    • R

    Parameters

    Returns void

DispatchArg

DispatchArg:

index

index: number

result

result: Observable<R>

subscriber

subscriber: ExpandSubscriber<T, R>

value

value: any

ExpandSignature

  • Parameters

    • project: function
    • Optional concurrent: number
    • Optional scheduler: Scheduler

    Returns Observable<T>

  • Type parameters

    • R

    Parameters

    • project: function
    • Optional concurrent: number
    • Optional scheduler: Scheduler

    Returns Observable<R>

expand

  • Returns an Observable where for each item in the source Observable, the supplied function is applied to each item, resulting in a new value to then be applied again with the function.

    method

    expand

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    • project: function

      the function for projecting the next emitted item of the Observable.

    • Default value concurrent: number = Number.POSITIVE_INFINITY
    • Default value scheduler: Scheduler = undefined

    Returns Observable<R>

    an Observable containing the expansions of the source Observable.

"node_modules/rxjs/src/operator/filter"

"node_modules/rxjs/src/operator/filter":

FilterOperator

FilterOperator:

constructor

  • new FilterOperator(predicate: function, thisArg?: any): FilterOperator

  • Parameters

    • predicate: function
        • (value: T, index: number): boolean

        • Parameters

          • value: T
          • index: number

          Returns boolean

    • Optional thisArg: any

    Returns FilterOperator

predicate

predicate: function

Type declaration

    • (value: T, index: number): boolean

    • Parameters

      • value: T
      • index: number

      Returns boolean

thisArg

thisArg: any

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

FilterSubscriber

FilterSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<T>
    • predicate: function
        • (value: T, index: number): boolean

        • Parameters

          • value: T
          • index: number

          Returns boolean

    • thisArg: any

    Returns FilterSubscriber

count

count: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

predicate

predicate: function

Type declaration

    • (value: T, index: number): boolean

    • Parameters

      • value: T
      • index: number

      Returns boolean

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

thisArg

thisArg: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

FilterSignature

  • __call(predicate: function, thisArg?: any): Observable<T>

  • Parameters

    • predicate: function
        • (value: T, index: number): boolean

        • Parameters

          • value: T
          • index: number

          Returns boolean

    • Optional thisArg: any

    Returns Observable<T>

filter

  • filter<T>(predicate: function, thisArg?: any): Observable<T>

  • Filter items emitted by the source Observable by only emitting those that satisfy a specified predicate.

    Like Array.prototype.filter(), it only emits a value from the source if it passes a criterion function.

    Similar to the well-known Array.prototype.filter method, this operator takes values from the source Observable, passes them through a predicate function and only emits those values that yielded true.

    example

    Emit only click events whose target was a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var clicksOnDivs = clicks.filter(ev => ev.target.tagName === 'DIV'); clicksOnDivs.subscribe(x => console.log(x));

    see

    distinct

    see

    distinctKey

    see

    distinctUntilChanged

    see

    distinctUntilKeyChanged

    see

    ignoreElements

    see

    partition

    see

    skip

    method

    filter

    owner

    Observable

    Type parameters

    • T

    Parameters

    • predicate: function

      A function that evaluates each value emitted by the source Observable. If it returns true, the value is emitted, if false the value is not passed to the output Observable. The index parameter is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

        • (value: T, index: number): boolean

        • Parameters

          • value: T
          • index: number

          Returns boolean

    • Optional thisArg: any

    Returns Observable<T>

    An Observable of values from the source that were allowed by the predicate function.

"node_modules/rxjs/src/operator/finally"

"node_modules/rxjs/src/operator/finally":

FinallyOperator

FinallyOperator:

constructor

  • Parameters

    • finallySelector: function
        • (): void

        • Returns void

    Returns FinallyOperator

finallySelector

finallySelector: function

Type declaration

    • (): void

    • Returns void

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

FinallySubscriber

FinallySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

FinallySignature

  • __call<T>(finallySelector: function): Observable<T>

  • Type parameters

    • T

    Parameters

    • finallySelector: function
        • (): void

        • Returns void

    Returns Observable<T>

_finally

  • _finally<T>(finallySelector: function): Observable<T>

  • Returns an Observable that mirrors the source Observable, but will call a specified function when the source terminates on complete or error.

    method

    finally

    owner

    Observable

    Type parameters

    • T

    Parameters

    • finallySelector: function

      function to be called when source terminates.

        • (): void

        • Returns void

    Returns Observable<T>

    an Observable that mirrors the source, but will call the specified function on termination.

"node_modules/rxjs/src/operator/find"

"node_modules/rxjs/src/operator/find":

FindValueOperator

FindValueOperator:

constructor

  • Parameters

    • predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • source: Observable<T>
    • yieldIndex: boolean
    • Optional thisArg: any

    Returns FindValueOperator

predicate

predicate: function

Type declaration

    • (value: T, index: number, source: Observable<T>): boolean

    • Parameters

      Returns boolean

source

source: Observable<T>

thisArg

thisArg: any

yieldIndex

yieldIndex: boolean

call

  • Parameters

    Returns any

FindValueSubscriber

FindValueSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

predicate

predicate: function

Type declaration

    • (value: T, index: number, source: Observable<T>): boolean

    • Parameters

      Returns boolean

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

thisArg

thisArg: any

yieldIndex

yieldIndex: boolean

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

  • notifyComplete(value: any): void

  • Parameters

    • value: any

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

FindSignature

  • __call(predicate: function, thisArg?: any): Observable<T>

  • Parameters

    • predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Observable<T>

find

  • find<T>(predicate: function, thisArg?: any): Observable<T>

  • Emits only the first value emitted by the source Observable that meets some condition.

    Finds the first value that passes some test and emits that.

    find searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the first occurrence in the source. Unlike first, the predicate is required in find, and does not emit an error if a valid value is not found.

    example

    Find and emit the first click that happens on a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.find(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

    see

    filter

    see

    first

    see

    findIndex

    see

    take

    method

    find

    owner

    Observable

    Type parameters

    • T

    Parameters

    • predicate: function

      A function called with each item to test for condition matching.

        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Observable<T>

    An Observable of the first item that matches the condition.

"node_modules/rxjs/src/operator/findIndex"

"node_modules/rxjs/src/operator/findIndex":

FindIndexSignature

  • __call(predicate: function, thisArg?: any): Observable<number>

  • Parameters

    • predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Observable<number>

findIndex

  • findIndex<T>(predicate: function, thisArg?: any): Observable<number>

  • Emits only the index of the first value emitted by the source Observable that meets some condition.

    It's like find, but emits the index of the found value, not the value itself.

    findIndex searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the (zero-based) index of the first occurrence in the source. Unlike first, the predicate is required in findIndex, and does not emit an error if a valid value is not found.

    example

    Emit the index of first click that happens on a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.findIndex(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

    see

    filter

    see

    find

    see

    first

    see

    take

    method

    find

    owner

    Observable

    Type parameters

    • T

    Parameters

    • predicate: function

      A function called with each item to test for condition matching.

        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional thisArg: any

    Returns Observable<number>

    An Observable of the index of the first item that matches the condition.

"node_modules/rxjs/src/operator/first"

"node_modules/rxjs/src/operator/first":

FirstOperator

FirstOperator:

constructor

  • new FirstOperator(predicate?: function, resultSelector?: function, defaultValue?: any, source?: Observable<T>): FirstOperator

  • Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional resultSelector: function
        • (value: T, index: number): R

        • Parameters

          • value: T
          • index: number

          Returns R

    • Optional defaultValue: any
    • Optional source: Observable<T>

    Returns FirstOperator

defaultValue

defaultValue: any

predicate

predicate: function

Type declaration

    • (value: T, index: number, source: Observable<T>): boolean

    • Parameters

      Returns boolean

resultSelector

resultSelector: function

Type declaration

    • (value: T, index: number): R

    • Parameters

      • value: T
      • index: number

      Returns R

source

source: Observable<T>

call

  • Parameters

    Returns any

FirstSubscriber

FirstSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<R>
    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional resultSelector: function
        • (value: T, index: number): R

        • Parameters

          • value: T
          • index: number

          Returns R

    • Optional defaultValue: any
    • Optional source: Observable<T>

    Returns FirstSubscriber

defaultValue

defaultValue: any

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

predicate

predicate: function

Type declaration

    • (value: T, index: number, source: Observable<T>): boolean

    • Parameters

      Returns boolean

resultSelector

resultSelector: function

Type declaration

    • (value: T, index: number): R

    • Parameters

      • value: T
      • index: number

      Returns R

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_emit

  • _emit(value: any, index: number): void

  • Parameters

    • value: any
    • index: number

    Returns void

_emitFinal

  • _emitFinal(value: any): void

  • Parameters

    • value: any

    Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_tryPredicate

  • _tryPredicate(value: T, index: number): void

  • Parameters

    • value: T
    • index: number

    Returns void

_tryResultSelector

  • _tryResultSelector(value: T, index: number): void

  • Parameters

    • value: T
    • index: number

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

FirstSignature

  • __call(predicate?: function): Observable<T>
  • __call(predicate: function, resultSelector: void, defaultValue?: T): Observable<T>
  • __call<R>(predicate?: function, resultSelector?: function, defaultValue?: R): Observable<R>

  • Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    Returns Observable<T>

  • Parameters

    • predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • resultSelector: void
    • Optional defaultValue: T

    Returns Observable<T>

  • Type parameters

    • R

    Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional resultSelector: function
        • (value: T, index: number): R

        • Parameters

          • value: T
          • index: number

          Returns R

    • Optional defaultValue: R

    Returns Observable<R>

first

  • first<T, R>(predicate?: function, resultSelector?: function, defaultValue?: R): Observable<T | R>

  • Emits only the first value (or the first value that meets some condition) emitted by the source Observable.

    Emits only the first value. Or emits only the first value that passes some test.

    If called with no arguments, first emits the first value of the source Observable, then completes. If called with a predicate function, first emits the first value of the source that matches the specified condition. It may also take a resultSelector function to produce the output value from the input value, and a defaultValue to emit in case the source completes before it is able to emit a valid value. Throws an error if defaultValue was not provided and a matching element is not found.

    example

    Emit only the first click that happens on the DOM var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.first(); result.subscribe(x => console.log(x));

    example

    Emits the first click that happens on a DIV var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.first(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

    see

    filter

    see

    find

    see

    take

    throws

    {EmptyError} Delivers an EmptyError to the Observer's error callback if the Observable completes before any next notification was sent.

    method

    first

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional resultSelector: function
        • (value: T, index: number): R

        • Parameters

          • value: T
          • index: number

          Returns R

    • Optional defaultValue: R

    Returns Observable<T | R>

    an Observable of the first item that matches the condition.

"node_modules/rxjs/src/operator/groupBy"

"node_modules/rxjs/src/operator/groupBy":

GroupByOperator

GroupByOperator:

constructor

  • new GroupByOperator(source: Observable<T>, keySelector: function, elementSelector?: function, durationSelector?: function): GroupByOperator

  • Parameters

    • source: Observable<T>
    • keySelector: function
        • (value: T): K

        • Parameters

          • value: T

          Returns K

    • Optional elementSelector: function
        • (value: T): R

        • Parameters

          • value: T

          Returns R

    • Optional durationSelector: function

    Returns GroupByOperator

durationSelector

durationSelector: function

Type declaration

elementSelector

elementSelector: function

Type declaration

    • (value: T): R

    • Parameters

      • value: T

      Returns R

keySelector

keySelector: function

Type declaration

    • (value: T): K

    • Parameters

      • value: T

      Returns K

source

source: Observable<T>

call

  • Parameters

    Returns any

GroupBySubscriber

GroupBySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

attemptedToUnsubscribe

attemptedToUnsubscribe: boolean

count

count: number

destination

destination: PartialObserver

durationSelector

durationSelector: function

Type declaration

elementSelector

elementSelector: function

Type declaration

    • (value: T): R

    • Parameters

      • value: T

      Returns R

groups

groups: Map<K, Subject<T | R>>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

keySelector

keySelector: function

Type declaration

    • (value: T): K

    • Parameters

      • value: T

      Returns K

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_group

  • _group(value: T, key: K): void

  • Parameters

    • value: T
    • key: K

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_selectDuration

  • _selectDuration(key: K, group: any): void

  • Parameters

    • key: K
    • group: any

    Returns void

_selectElement

  • _selectElement(value: T, group: Subject<T | R>): void

  • Parameters

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

removeGroup

  • removeGroup(key: K): void

  • Parameters

    • key: K

    Returns void

tryGroupNext

  • tryGroupNext(value: T | R, group: Subject<T | R>): void

  • Parameters

    • value: T | R
    • group: Subject<T | R>

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

GroupDurationSubscriber

GroupDurationSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

group

group: Subject<T>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

key

key: K

parent

parent: GroupBySubscriber<any, K, T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

tryComplete

  • tryComplete(): void

  • Returns void

tryError

  • tryError(err: any): void

  • Parameters

    • err: any

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

GroupedObservable

GroupedObservable:

An Observable representing values belonging to the same group represented by a common key. The values emitted by a GroupedObservable come from the source Observable. The common key is available as the field key on a GroupedObservable instance.

class

GroupedObservable

constructor

_isScalar

_isScalar: boolean

groupSubject

groupSubject: Subject<T>

key

key: K

operator

operator: Operator<any, T>

refCountSubscription

refCountSubscription: RefCountSubscription

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates a new cold Observable by calling the Observable constructor

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    a new cold observable

InnerRefCountSubscription

InnerRefCountSubscription:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

parent

parent: RefCountSubscription

EMPTY

EMPTY: Subscription

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

GroupBySignature

  • Type parameters

    • K

    Parameters

    • keySelector: function
        • (value: T): K

        • Parameters

          • value: T

          Returns K

    Returns Observable<GroupedObservable<K, T>>

  • Type parameters

    • K

    Parameters

    Returns Observable<GroupedObservable<K, T>>

  • Type parameters

    • K

    • R

    Parameters

    • keySelector: function
        • (value: T): K

        • Parameters

          • value: T

          Returns K

    • Optional elementSelector: function
        • (value: T): R

        • Parameters

          • value: T

          Returns R

    • Optional durationSelector: function

    Returns Observable<GroupedObservable<K, R>>

RefCountSubscription

RefCountSubscription:

attemptedToUnsubscribe

attemptedToUnsubscribe: boolean

count

count: number

isUnsubscribed

isUnsubscribed: boolean

unsubscribe

unsubscribe: function

Type declaration

    • (): void

    • Returns void

groupBy

  • groupBy<T, K, R>(keySelector: function, elementSelector?: function, durationSelector?: function): Observable<GroupedObservable<K, R>>

  • Groups the items emitted by an Observable according to a specified criterion, and emits these grouped items as GroupedObservables, one GroupedObservable per group.

    method

    groupBy

    owner

    Observable

    Type parameters

    • T

    • K

    • R

    Parameters

    • keySelector: function

      a function that extracts the key for each item.

        • (value: T): K

        • Parameters

          • value: T

          Returns K

    • Optional elementSelector: function
        • (value: T): R

        • Parameters

          • value: T

          Returns R

    • Optional durationSelector: function

    Returns Observable<GroupedObservable<K, R>>

    an Observable that emits GroupedObservables, each of which corresponds to a unique key value and each of which emits those items from the source Observable that share that key value.

"node_modules/rxjs/src/operator/ignoreElements"

"node_modules/rxjs/src/operator/ignoreElements":

IgnoreElementsOperator

IgnoreElementsOperator:

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

IgnoreElementsSubscriber

IgnoreElementsSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(unused: T): void

  • Parameters

    • unused: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

IgnoreElementsSignature

  • Returns Observable<T>

ignoreElements

  • Ignores all items emitted by the source Observable and only passes calls of complete or error.

    method

    ignoreElements

    owner

    Observable

    Type parameters

    • T

    Returns Observable<T>

    an empty Observable that only calls complete or error, based on which one is called by the source Observable.

"node_modules/rxjs/src/operator/isEmpty"

"node_modules/rxjs/src/operator/isEmpty":

IsEmptyOperator

IsEmptyOperator:

call

  • call(observer: Subscriber<boolean>, source: any): any

  • Parameters

    Returns any

IsEmptySubscriber

IsEmptySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: any): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: any

    Returns void

notifyComplete

  • notifyComplete(isEmpty: boolean): void

  • Parameters

    • isEmpty: boolean

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

IsEmptySignature

  • Returns Observable<boolean>

isEmpty

  • If the source Observable is empty it returns an Observable that emits true, otherwise it emits false.

    method

    isEmpty

    owner

    Observable

    Returns Observable<boolean>

    an Observable that emits a Boolean.

"node_modules/rxjs/src/operator/last"

"node_modules/rxjs/src/operator/last":

LastOperator

LastOperator:

constructor

  • new LastOperator(predicate?: function, resultSelector?: function, defaultValue?: any, source?: Observable<T>): LastOperator

  • Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional resultSelector: function
        • (value: T, index: number): R

        • Parameters

          • value: T
          • index: number

          Returns R

    • Optional defaultValue: any
    • Optional source: Observable<T>

    Returns LastOperator

defaultValue

defaultValue: any

predicate

predicate: function

Type declaration

    • (value: T, index: number, source: Observable<T>): boolean

    • Parameters

      Returns boolean

resultSelector

resultSelector: function

Type declaration

    • (value: T, index: number): R

    • Parameters

      • value: T
      • index: number

      Returns R

source

source: Observable<T>

call

  • Parameters

    Returns any

LastSubscriber

LastSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<R>
    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional resultSelector: function
        • (value: T, index: number): R

        • Parameters

          • value: T
          • index: number

          Returns R

    • Optional defaultValue: any
    • Optional source: Observable<T>

    Returns LastSubscriber

defaultValue

defaultValue: any

destination

destination: PartialObserver

hasValue

hasValue: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

lastValue

lastValue: T | R

predicate

predicate: function

Type declaration

    • (value: T, index: number, source: Observable<T>): boolean

    • Parameters

      Returns boolean

resultSelector

resultSelector: function

Type declaration

    • (value: T, index: number): R

    • Parameters

      • value: T
      • index: number

      Returns R

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_tryPredicate

  • _tryPredicate(value: T, index: number): void

  • Parameters

    • value: T
    • index: number

    Returns void

_tryResultSelector

  • _tryResultSelector(value: T, index: number): void

  • Parameters

    • value: T
    • index: number

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

LastSignature

  • __call(predicate?: function): Observable<T>
  • __call(predicate: function, resultSelector: void, defaultValue?: T): Observable<T>
  • __call<R>(predicate?: function, resultSelector?: function, defaultValue?: R): Observable<R>

  • Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    Returns Observable<T>

  • Parameters

    • predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • resultSelector: void
    • Optional defaultValue: T

    Returns Observable<T>

  • Type parameters

    • R

    Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional resultSelector: function
        • (value: T, index: number): R

        • Parameters

          • value: T
          • index: number

          Returns R

    • Optional defaultValue: R

    Returns Observable<R>

last

  • last<T, R>(predicate?: function, resultSelector?: function, defaultValue?: R): Observable<T | R>

  • Returns an Observable that emits only the last item emitted by the source Observable. It optionally takes a predicate function as a parameter, in which case, rather than emitting the last item from the source Observable, the resulting Observable will emit the last item from the source Observable that satisfies the predicate.

    throws

    {EmptyError} Delivers an EmptyError to the Observer's error callback if the Observable completes before any next notification was sent.

    throws
    • Throws if no items that match the predicate are emitted by the source Observable.
    method

    last

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    • Optional predicate: function

      the condition any source emitted item has to satisfy.

        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional resultSelector: function
        • (value: T, index: number): R | void

        • Parameters

          • value: T
          • index: number

          Returns R | void

    • Optional defaultValue: R

    Returns Observable<T | R>

    an Observable that emits only the last item satisfying the given condition from the source, or an NoSuchElementException if no such items are emitted.

"node_modules/rxjs/src/operator/let"

"node_modules/rxjs/src/operator/let":

LetSignature

letProto

"node_modules/rxjs/src/operator/map"

"node_modules/rxjs/src/operator/map":

MapOperator

MapOperator:

constructor

  • new MapOperator(project: function, thisArg: any): MapOperator

  • Parameters

    • project: function
        • (value: T, index: number): R

        • Parameters

          • value: T
          • index: number

          Returns R

    • thisArg: any

    Returns MapOperator

project

project: function

Type declaration

    • (value: T, index: number): R

    • Parameters

      • value: T
      • index: number

      Returns R

thisArg

thisArg: any

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

MapSubscriber

MapSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<R>
    • project: function
        • (value: T, index: number): R

        • Parameters

          • value: T
          • index: number

          Returns R

    • thisArg: any

    Returns MapSubscriber

count

count: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

project

project: function

Type declaration

    • (value: T, index: number): R

    • Parameters

      • value: T
      • index: number

      Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

thisArg

thisArg: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MapSignature

  • __call<R>(project: function, thisArg?: any): Observable<R>

  • Type parameters

    • R

    Parameters

    • project: function
        • (value: T, index: number): R

        • Parameters

          • value: T
          • index: number

          Returns R

    • Optional thisArg: any

    Returns Observable<R>

map

  • map<T, R>(project: function, thisArg?: any): Observable<R>

  • Applies a given project function to each value emitted by the source Observable, and emits the resulting values as an Observable.

    Like Array.prototype.map(), it passes each source value through a transformation function to get corresponding output values.

    Similar to the well known Array.prototype.map function, this operator applies a projection to each value and emits that projection in the output Observable.

    example

    Map every every click to the clientX position of that click var clicks = Rx.Observable.fromEvent(document, 'click'); var positions = clicks.map(ev => ev.clientX); positions.subscribe(x => console.log(x));

    see

    mapTo

    see

    pluck

    method

    map

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    • project: function

      The function to apply to each value emitted by the source Observable. The index parameter is the number i for the i-th emission that has happened since the subscription, starting from the number 0.

        • (value: T, index: number): R

        • Parameters

          • value: T
          • index: number

          Returns R

    • Optional thisArg: any

    Returns Observable<R>

    An Observable that emits the values from the source Observable transformed by the given project function.

"node_modules/rxjs/src/operator/mapTo"

"node_modules/rxjs/src/operator/mapTo":

MapToOperator

MapToOperator:

constructor

  • Parameters

    • value: R

    Returns MapToOperator

value

value: R

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

MapToSubscriber

MapToSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

value

value: R

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(x: T): void

  • Parameters

    • x: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MapToSignature

  • Type parameters

    • R

    Parameters

    • value: R

    Returns Observable<R>

mapTo

  • Emits the given constant value on the output Observable every time the source Observable emits a value.

    Like {@link map}, but it maps every source value to the same output value every time.

    Takes a constant value as argument, and emits that whenever the source Observable emits a value. In other words, ignores the actual source value, and simply uses the emission moment to know when to emit the given value.

    example

    Map every every click to the string 'Hi' var clicks = Rx.Observable.fromEvent(document, 'click'); var greetings = clicks.mapTo('Hi'); greetings.subscribe(x => console.log(x));

    see

    {@link map}

    method

    mapTo

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    • value: R

      The value to map each source value to.

    Returns Observable<R>

    An Observable that emits the given value every time the source Observable emits something.

"node_modules/rxjs/src/operator/materialize"

"node_modules/rxjs/src/operator/materialize":

MaterializeOperator

MaterializeOperator:

call

  • Parameters

    Returns any

MaterializeSubscriber

MaterializeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MaterializeSignature

materialize

  • Returns an Observable that represents all of the emissions and notifications from the source Observable into emissions marked with their original types within a Notification objects.

    see

    Notification

    scheduler

    materialize does not operate by default on a particular Scheduler.

    method

    materialize

    owner

    Observable

    Type parameters

    • T

    Returns Observable<Notification<T>>

    an Observable that emits items that are the result of materializing the items and notifications of the source Observable.

"node_modules/rxjs/src/operator/max"

"node_modules/rxjs/src/operator/max":

MaxSignature

  • Parameters

    • Optional comparer: function
        • (x: T, y: T): T

        • Parameters

          • x: T
          • y: T

          Returns T

    Returns Observable<T>

max

  • The Max operator operates on an Observable that emits numbers (or items that can be evaluated as numbers), and when source Observable completes it emits a single item: the item with the largest number.

    method

    max

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Optional comparer: function
        • (x: T, y: T): T

        • Parameters

          • x: T
          • y: T

          Returns T

    Returns Observable<T>

    an Observable that emits item with the largest number.

"node_modules/rxjs/src/operator/merge"

"node_modules/rxjs/src/operator/merge":

MergeSignature

merge

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (either the source or an Observable given as argument), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    example

    Merge together two Observables: 1s interval and clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var clicksOrTimer = clicks.merge(timer); clicksOrTimer.subscribe(x => console.log(x));

    example

    Merge together 3 Observables, but only 2 run concurrently var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var concurrent = 2; // the argument var merged = timer1.merge(timer2, timer3, concurrent); merged.subscribe(x => console.log(x));

    see

    mergeAll

    see

    mergeMap

    see

    mergeMapTo

    see

    mergeScan

    method

    merge

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    Returns Observable<R>

    an Observable that emits items that are the result of every input Observable.

mergeStatic

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    • T2

    Parameters

    Returns Observable<T | T2>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    • T2

    Parameters

    Returns Observable<T | T2>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    • T2

    • T3

    Parameters

    Returns Observable<T | T2 | T3>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    • T2

    • T3

    Parameters

    Returns Observable<T | T2 | T3>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    • T2

    • T3

    • T4

    Parameters

    Returns Observable<T | T2 | T3 | T4>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    • T2

    • T3

    • T4

    Parameters

    Returns Observable<T | T2 | T3 | T4>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    Parameters

    Returns Observable<T | T2 | T3 | T4 | T5>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    Parameters

    Returns Observable<T | T2 | T3 | T4 | T5>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    Returns Observable<T | T2 | T3 | T4 | T5 | T6>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    Returns Observable<T | T2 | T3 | T4 | T5 | T6>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    an Observable that emits items that are the result of every input Observable.

  • Creates an output Observable which concurrently emits all values from every given input Observable.

    Flattens multiple Observables together by blending their values into one Observable.

    merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

    Type parameters

    • T

    • R

    Parameters

    Returns Observable<R>

    an Observable that emits items that are the result of every input Observable.

"node_modules/rxjs/src/operator/mergeAll"

"node_modules/rxjs/src/operator/mergeAll":

MergeAllOperator

MergeAllOperator:

constructor

  • Parameters

    • concurrent: number

    Returns MergeAllOperator

concurrent

concurrent: number

call

  • call(observer: Observer<T>, source: any): any

  • Parameters

    Returns any

MergeAllSubscriber

MergeAllSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

active

active: number

buffer

buffer: Observable<T>[]

concurrent

concurrent: number

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • Parameters

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    Returns void

notifyComplete

notifyError

notifyNext

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MergeAllSignature

  • __call(concurrent?: number): T

  • Parameters

    • Optional concurrent: number

    Returns T

mergeAll

  • mergeAll<T>(concurrent?: number): T

  • Converts a higher-order Observable into a first-order Observable which concurrently delivers all values that are emitted on the inner Observables.

    Flattens an Observable-of-Observables.

    mergeAll subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, it subscribes to that and delivers all the values from the inner Observable on the output Observable. The output Observable only completes once all inner Observables have completed. Any error delivered by a inner Observable will be immediately emitted on the output Observable.

    example

    Spawn a new interval Observable for each click event, and blend their outputs as one Observable var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000)); var firstOrder = higherOrder.mergeAll(); firstOrder.subscribe(x => console.log(x));

    example

    Count from 0 to 9 every second for each click, but only allow 2 concurrent timers var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000).take(10)); var firstOrder = higherOrder.mergeAll(2); firstOrder.subscribe(x => console.log(x));

    see

    combineAll

    see

    concatAll

    see

    exhaust

    see

    merge

    see

    mergeMap

    see

    mergeMapTo

    see

    mergeScan

    see

    switch

    see

    zipAll

    method

    mergeAll

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Default value concurrent: number = Number.POSITIVE_INFINITY

    Returns T

    An Observable that emits values coming from all the inner Observables emitted by the source Observable.

"node_modules/rxjs/src/operator/mergeMap"

"node_modules/rxjs/src/operator/mergeMap":

MergeMapOperator

MergeMapOperator:

constructor

  • new MergeMapOperator(project: function, resultSelector?: function, concurrent?: number): MergeMapOperator

  • Parameters

    • project: function
    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    • Default value concurrent: number = Number.POSITIVE_INFINITY

    Returns MergeMapOperator

concurrent

concurrent: number

project

project: function

Type declaration

resultSelector

resultSelector: function

Type declaration

    • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

    • Parameters

      • outerValue: T
      • innerValue: I
      • outerIndex: number
      • innerIndex: number

      Returns R

call

  • Parameters

    Returns any

MergeMapSubscriber

MergeMapSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<I>
    • project: function
    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    • Default value concurrent: number = Number.POSITIVE_INFINITY

    Returns MergeMapSubscriber

active

active: number

buffer

buffer: Observable<any>[]

concurrent

concurrent: number

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

project

project: function

Type declaration

resultSelector

resultSelector: function

Type declaration

    • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

    • Parameters

      • outerValue: T
      • innerValue: I
      • outerIndex: number
      • innerIndex: number

      Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_innerSub

  • _innerSub(ish: any, value: T, index: number): void

  • Parameters

    • ish: any
    • value: T
    • index: number

    Returns void

_next

  • _next(value: any): void

  • Parameters

    • value: any

    Returns void

_notifyResultSelector

  • _notifyResultSelector(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): void

  • Parameters

    • outerValue: T
    • innerValue: I
    • outerIndex: number
    • innerIndex: number

    Returns void

_tryNext

  • _tryNext(value: any): void

  • Parameters

    • value: any

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, I>): void

  • Parameters

    • outerValue: T
    • innerValue: I
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, I>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MergeMapSignature

  • __call<R>(project: function, concurrent?: number): Observable<R>
  • __call<I, R>(project: function, resultSelector: function, concurrent?: number): Observable<R>

  • Type parameters

    • R

    Parameters

    Returns Observable<R>

  • Type parameters

    • I

    • R

    Parameters

    • project: function
    • resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    • Optional concurrent: number

    Returns Observable<R>

mergeMap

  • mergeMap<T, I, R>(project: function, resultSelector?: function | number, concurrent?: number): Observable<R>

  • Projects each source value to an Observable which is merged in the output Observable.

    Maps each value to an Observable, then flattens all of these inner Observables using mergeAll.

    Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an Observable, and then merging those resulting Observables and emitting the results of this merger.

    example

    Map and flatten each letter to an Observable ticking every 1 second var letters = Rx.Observable.of('a', 'b', 'c'); var result = letters.mergeMap(x => Rx.Observable.interval(1000).map(i => x+i) ); result.subscribe(x => console.log(x));

    see

    concatMap

    see

    exhaustMap

    see

    merge

    see

    mergeAll

    see

    mergeMapTo

    see

    mergeScan

    see

    switchMap

    method

    mergeMap

    owner

    Observable

    Type parameters

    • T

    • I

    • R

    Parameters

    • project: function

      A function that, when applied to an item emitted by the source Observable, returns an Observable.

    • Optional resultSelector: function | number
    • Default value concurrent: number = Number.POSITIVE_INFINITY

    Returns Observable<R>

    An Observable that emits the result of applying the projection function (and the optional resultSelector) to each item emitted by the source Observable and merging the results of the Observables obtained from this transformation.

"node_modules/rxjs/src/operator/mergeMapTo"

"node_modules/rxjs/src/operator/mergeMapTo":

MergeMapToOperator

MergeMapToOperator:

constructor

  • Parameters

    • ish: SubscribableOrPromise
    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    • Default value concurrent: number = Number.POSITIVE_INFINITY

    Returns MergeMapToOperator

concurrent

concurrent: number

ish

ish: SubscribableOrPromise

resultSelector

resultSelector: function

Type declaration

    • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

    • Parameters

      • outerValue: T
      • innerValue: I
      • outerIndex: number
      • innerIndex: number

      Returns R

call

  • Parameters

    Returns any

MergeMapToSubscriber

MergeMapToSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<R>
    • ish: SubscribableOrPromise
    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    • Default value concurrent: number = Number.POSITIVE_INFINITY

    Returns MergeMapToSubscriber

active

active: number

buffer

buffer: Observable<any>[]

concurrent

concurrent: number

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

ish

ish: SubscribableOrPromise

resultSelector

resultSelector: function

Type declaration

    • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

    • Parameters

      • outerValue: T
      • innerValue: I
      • outerIndex: number
      • innerIndex: number

      Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_innerSub

  • _innerSub(ish: any, destination: PartialObserver, resultSelector: function, value: T, index: number): void

  • Parameters

    • ish: any
    • destination: PartialObserver
    • resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    • value: T
    • index: number

    Returns void

_next

  • _next(value: any): void

  • Parameters

    • value: any

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

  • notifyError(err: any): void

  • Parameters

    • err: any

    Returns void

notifyNext

  • notifyNext(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, I>): void

  • Parameters

    • outerValue: T
    • innerValue: I
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, I>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

trySelectResult

  • trySelectResult(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): void

  • Parameters

    • outerValue: T
    • innerValue: I
    • outerIndex: number
    • innerIndex: number

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MergeMapToSignature

  • Type parameters

    • R

    Parameters

    Returns Observable<R>

  • Type parameters

    • I

    • R

    Parameters

    • observable: ObservableInput
    • resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    • Optional concurrent: number

    Returns Observable<R>

mergeMapTo

  • mergeMapTo<T, I, R>(innerObservable: Observable<I>, resultSelector?: function | number, concurrent?: number): Observable<R>

  • Projects each source value to the same Observable which is merged multiple times in the output Observable.

    It's like mergeMap, but maps each value always to the same inner Observable.

    Maps each source value to the given Observable innerObservable regardless of the source value, and then merges those resulting Observables into one single Observable, which is the output Observable.

    example

    For each click event, start an interval Observable ticking every 1 second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.mergeMapTo(Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

    see

    concatMapTo

    see

    merge

    see

    mergeAll

    see

    mergeMap

    see

    mergeScan

    see

    switchMapTo

    method

    mergeMapTo

    owner

    Observable

    Type parameters

    • T

    • I

    • R

    Parameters

    • innerObservable: Observable<I>

      An Observable to replace each value from the source Observable.

    • Optional resultSelector: function | number
    • Default value concurrent: number = Number.POSITIVE_INFINITY

    Returns Observable<R>

    An Observable that emits items from the given innerObservable (and optionally transformed through resultSelector) every time a value is emitted on the source Observable.

"node_modules/rxjs/src/operator/mergeScan"

"node_modules/rxjs/src/operator/mergeScan":

MergeScanOperator

MergeScanOperator:

constructor

  • new MergeScanOperator(project: function, seed: R, concurrent: number): MergeScanOperator

  • Parameters

    • project: function
    • seed: R
    • concurrent: number

    Returns MergeScanOperator

concurrent

concurrent: number

project

project: function

Type declaration

seed

seed: R

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

MergeScanSubscriber

MergeScanSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

acc

acc: R

active

active: number

buffer

buffer: Observable<any>[]

concurrent

concurrent: number

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

hasValue

hasValue: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

project

project: function

Type declaration

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_innerSub

  • _innerSub(ish: any, value: T, index: number): void

  • Parameters

    • ish: any
    • value: T
    • index: number

    Returns void

_next

  • _next(value: any): void

  • Parameters

    • value: any

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MergeScanSignature

  • __call<R>(project: function, seed: R, concurrent?: number): Observable<R>

  • Type parameters

    • R

    Parameters

    • project: function
    • seed: R
    • Optional concurrent: number

    Returns Observable<R>

mergeScan

  • mergeScan<T, R>(project: function, seed: R, concurrent?: number): Observable<R>
  • method

    mergeScan

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    • project: function
    • seed: R
    • Default value concurrent: number = Number.POSITIVE_INFINITY

    Returns Observable<R>

"node_modules/rxjs/src/operator/min"

"node_modules/rxjs/src/operator/min":

MinSignature

  • Parameters

    • Optional comparer: function
        • (x: T, y: T): T

        • Parameters

          • x: T
          • y: T

          Returns T

    Returns Observable<T>

min

  • The Min operator operates on an Observable that emits numbers (or items that can be evaluated as numbers), and when source Observable completes it emits a single item: the item with the smallest number.

    method

    min

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Optional comparer: function
        • (x: T, y: T): T

        • Parameters

          • x: T
          • y: T

          Returns T

    Returns Observable<T>

    an Observable that emits item with the smallest number.

"node_modules/rxjs/src/operator/multicast"

"node_modules/rxjs/src/operator/multicast":

MulticastSignature

factoryOrValue

factoryOrValue: T | function

multicast

  • Returns an Observable that emits the results of invoking a specified selector on items emitted by a ConnectableObservable that shares a single subscription to the underlying stream.

    method

    multicast

    owner

    Observable

    Type parameters

    • T

    Parameters

    • subjectOrSubjectFactory: Subject<T> | function

    Returns ConnectableObservable<T>

    an Observable that emits the results of invoking the selector on the items emitted by a ConnectableObservable that shares a single subscription to the underlying stream.

"node_modules/rxjs/src/operator/observeOn"

"node_modules/rxjs/src/operator/observeOn":

ObserveOnMessage

ObserveOnMessage:

constructor

destination

destination: PartialObserver

notification

notification: Notification<any>

ObserveOnOperator

ObserveOnOperator:

constructor

  • Parameters

    • scheduler: Scheduler
    • Default value delay: number = 0

    Returns ObserveOnOperator

delay

delay: number

scheduler

scheduler: Scheduler

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

ObserveOnSubscriber

ObserveOnSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

delay

delay: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

scheduleMessage

  • Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

dispatch

  • Parameters

    Returns void

ObserveOnSignature

  • Parameters

    • scheduler: Scheduler
    • Optional delay: number

    Returns Observable<T>

observeOn

  • see

    Notification

    method

    observeOn

    owner

    Observable

    Type parameters

    • T

    Parameters

    • scheduler: Scheduler
    • Default value delay: number = 0

    Returns Observable<T>

"node_modules/rxjs/src/operator/pairwise"

"node_modules/rxjs/src/operator/pairwise":

PairwiseOperator

PairwiseOperator:

call

  • call(subscriber: Subscriber<[T, T]>, source: any): any

  • Parameters

    Returns any

PairwiseSubscriber

PairwiseSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

hasPrev

hasPrev: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

prev

prev: T

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

PairwiseSignature

  • Returns Observable<[T, T]>

pairwise

  • Returns a new observable that triggers on the second and following inputs. An input that triggers an event will return an pair of [(N - 1)th, Nth]. The (N-1)th is stored in the internal state until Nth input occurs.

    method

    pairwise

    owner

    Observable

    Type parameters

    • T

    Returns Observable<[T, T]>

    an observable of pairs of values.

"node_modules/rxjs/src/operator/partition"

"node_modules/rxjs/src/operator/partition":

PartitionSignature

  • Parameters

    • predicate: function
        • (value: T): boolean

        • Parameters

          • value: T

          Returns boolean

    • Optional thisArg: any

    Returns [Observable<T>, Observable<T>]

partition

  • method

    partition

    owner

    Observable

    Type parameters

    • T

    Parameters

    • predicate: function
        • (value: T): boolean

        • Parameters

          • value: T

          Returns boolean

    • Optional thisArg: any

    Returns [Observable<T>, Observable<T>]

"node_modules/rxjs/src/operator/pluck"

"node_modules/rxjs/src/operator/pluck":

PluckSignature

  • __call<R>(...properties: string[]): Observable<R>

  • Type parameters

    • R

    Parameters

    • Rest ...properties: string[]

    Returns Observable<R>

pluck

  • pluck<R>(...properties: string[]): Observable<R>

  • Maps each source value (an object) to its specified nested property.

    Like {@link map}, but meant only for picking one of the nested properties of every emitted object.

    Given a list of strings describing a path to an object property, retrieves the value of a specified nested property from all values in the source Observable. If a property can't be resolved, it will return undefined for that value.

    example

    Map every every click to the tagName of the clicked target element var clicks = Rx.Observable.fromEvent(document, 'click'); var tagNames = clicks.pluck('target', 'tagName'); tagNames.subscribe(x => console.log(x));

    see

    {@link map}

    method

    pluck

    owner

    Observable

    Type parameters

    • R

    Parameters

    • Rest ...properties: string[]

      The nested properties to pluck from each source value (an object).

    Returns Observable<R>

    Returns a new Observable of property values from the source values.

plucker

  • plucker(props: string[], length: number): function

  • Parameters

    • props: string[]
    • length: number

    Returns function

      • (x: string): any

      • Parameters

        • x: string

        Returns any

"node_modules/rxjs/src/operator/publish"

"node_modules/rxjs/src/operator/publish":

PublishSignature

publish

  • Returns a ConnectableObservable, which is a variety of Observable that waits until its connect method is called before it begins emitting items to those Observers that have subscribed to it.

    method

    publish

    owner

    Observable

    Type parameters

    • T

    Returns ConnectableObservable<T>

    a ConnectableObservable that upon connection causes the source Observable to emit items to its Observers.

"node_modules/rxjs/src/operator/publishBehavior"

"node_modules/rxjs/src/operator/publishBehavior":

PublishBehaviorSignature

  • Parameters

    • value: T

    Returns ConnectableObservable<T>

publishBehavior

  • method

    publishBehavior

    owner

    Observable

    Type parameters

    • T

    Parameters

    • value: T

    Returns ConnectableObservable<T>

"node_modules/rxjs/src/operator/publishLast"

"node_modules/rxjs/src/operator/publishLast":

PublishLastSignature

publishLast

  • method

    publishLast

    owner

    Observable

    Type parameters

    • T

    Returns ConnectableObservable<T>

"node_modules/rxjs/src/operator/publishReplay"

"node_modules/rxjs/src/operator/publishReplay":

PublishReplaySignature

  • Parameters

    • Optional bufferSize: number
    • Optional windowTime: number
    • Optional scheduler: Scheduler

    Returns ConnectableObservable<T>

publishReplay

  • method

    publishReplay

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Default value bufferSize: number = Number.POSITIVE_INFINITY
    • Default value windowTime: number = Number.POSITIVE_INFINITY
    • Optional scheduler: Scheduler

    Returns ConnectableObservable<T>

"node_modules/rxjs/src/operator/race"

"node_modules/rxjs/src/operator/race":

RaceOperator

RaceOperator:

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

RaceSubscriber

RaceSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

hasFirst

hasFirst: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

observables

observables: Observable<any>[]

subscriptions

subscriptions: Subscription[]

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(observable: any): void

  • Parameters

    • observable: any

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

  • Parameters

    • outerValue: T
    • innerValue: T
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, T>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

RaceSignature

  • Parameters

    Returns Observable<T>

  • Type parameters

    • R

    Parameters

    Returns Observable<R>

race

  • Returns an Observable that mirrors the first source Observable to emit an item from the combination of this Observable and supplied Observables

    method

    race

    owner

    Observable

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    an Observable that mirrors the output of the first Observable to emit an item.

raceStatic

  • Returns an Observable that mirrors the first source Observable to emit an item.

    static

    true

    name

    race

    owner

    Observable

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    an Observable that mirrors the output of the first Observable to emit an item.

"node_modules/rxjs/src/operator/reduce"

"node_modules/rxjs/src/operator/reduce":

ReduceOperator

ReduceOperator:

constructor

  • Parameters

    • project: function
        • (acc: R, value: T): R

        • Parameters

          • acc: R
          • value: T

          Returns R

    • Optional seed: R

    Returns ReduceOperator

project

project: function

Type declaration

    • (acc: R, value: T): R

    • Parameters

      • acc: R
      • value: T

      Returns R

seed

seed: R

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

ReduceSubscriber

ReduceSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<R>
    • project: function
        • (acc: R, value: T): R

        • Parameters

          • acc: R
          • value: T

          Returns R

    • Optional seed: R

    Returns ReduceSubscriber

acc

acc: T | R

destination

destination: PartialObserver

hasSeed

hasSeed: boolean

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

project

project: function

Type declaration

    • (acc: R, value: T): R

    • Parameters

      • acc: R
      • value: T

      Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_tryReduce

  • _tryReduce(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

ReduceSignature

  • __call<R>(project: function, seed?: R): Observable<R>

  • Type parameters

    • R

    Parameters

    • project: function
        • (acc: R, value: T): R

        • Parameters

          • acc: R
          • value: T

          Returns R

    • Optional seed: R

    Returns Observable<R>

reduce

  • reduce<T, R>(project: function, seed?: R): Observable<R>

  • Returns an Observable that applies a specified accumulator function to the first item emitted by a source Observable, then feeds the result of that function along with the second item emitted by the source Observable into the same function, and so on until all items have been emitted by the source Observable, and emits the final result from the final call to your function as its sole item. This technique, which is called "reduce" here, is sometimes called "aggregate," "fold," "accumulate," "compress," or "inject" in other programming contexts.

    method

    reduce

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    • project: function
        • (acc: R, value: T): R

        • Parameters

          • acc: R
          • value: T

          Returns R

    • Optional seed: R

    Returns Observable<R>

    an Observable that emits a single item that is the result of accumulating the output from the items emitted by the source Observable.

"node_modules/rxjs/src/operator/repeat"

"node_modules/rxjs/src/operator/repeat":

RepeatOperator

RepeatOperator:

constructor

  • Parameters

    Returns RepeatOperator

count

count: number

source

source: Observable<T>

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

RepeatSubscriber

RepeatSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

count

count: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

RepeatSignature

  • Parameters

    • Optional count: number

    Returns Observable<T>

repeat

  • Returns an Observable that repeats the stream of items emitted by the source Observable at most count times, on a particular Scheduler.

    method

    repeat

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Default value count: number = -1

    Returns Observable<T>

    an Observable that repeats the stream of items emitted by the source Observable at most count times.

"node_modules/rxjs/src/operator/retry"

"node_modules/rxjs/src/operator/retry":

RetryOperator

RetryOperator:

constructor

  • Parameters

    Returns RetryOperator

count

count: number

source

source: Observable<T>

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

RetrySubscriber

RetrySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

count

count: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err: any): void

  • Parameters

    • err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

RetrySignature

  • Parameters

    • Optional count: number

    Returns Observable<T>

retry

  • Returns an Observable that mirrors the source Observable, resubscribing to it if it calls error and the predicate returns true for that specific exception and retry count. If the source Observable calls error, this method will resubscribe to the source Observable for a maximum of count resubscriptions (given as a number parameter) rather than propagating the error call.

    Any and all items emitted by the source Observable will be emitted by the resulting Observable, even those emitted during failed subscriptions. For example, if an Observable fails at first but emits [1, 2] then succeeds the second time and emits: [1, 2, 3, 4, 5] then the complete stream of emissions and notifications would be: [1, 2, 1, 2, 3, 4, 5, complete].

    method

    retry

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Default value count: number = -1

    Returns Observable<T>

    the source Observable modified with the retry logic.

"node_modules/rxjs/src/operator/retryWhen"

"node_modules/rxjs/src/operator/retryWhen":

RetryWhenOperator

RetryWhenOperator:

constructor

notifier

notifier: function

Type declaration

source

source: Observable<T>

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

RetryWhenSubscriber

RetryWhenSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

errors

errors: Subject<any>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

notifier

notifier: function

Type declaration

retries

retries: Observable<any>

retriesSubscription

retriesSubscription: Subscription

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err: any): void

  • Parameters

    • err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

RetryWhenSignature

retryWhen

  • Returns an Observable that emits the same values as the source observable with the exception of an error. An error will cause the emission of the Throwable that cause the error to the Observable returned from notificationHandler. If that Observable calls onComplete or error then retry will call complete or error on the child subscription. Otherwise, this Observable will resubscribe to the source observable, on a particular Scheduler.

    method

    retryWhen

    owner

    Observable

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    the source Observable modified with retry logic.

"node_modules/rxjs/src/operator/sample"

"node_modules/rxjs/src/operator/sample":

SampleOperator

SampleOperator:

constructor

notifier

notifier: Observable<any>

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

SampleSubscriber

SampleSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

value

value: T

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

emitValue

  • emitValue(): void

  • Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

  • notifyComplete(): void

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SampleSignature

  • Parameters

    Returns Observable<T>

sample

  • Returns an Observable that, when the specified sampler Observable emits an item or completes, it then emits the most recently emitted item (if any) emitted by the source Observable since the previous emission from the sampler Observable.

    method

    sample

    owner

    Observable

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    an Observable that emits the results of sampling the items emitted by this Observable whenever the sampler Observable emits an item or completes.

"node_modules/rxjs/src/operator/sampleTime"

"node_modules/rxjs/src/operator/sampleTime":

SampleTimeOperator

SampleTimeOperator:

constructor

delay

delay: number

scheduler

scheduler: Scheduler

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

SampleTimeSubscriber

SampleTimeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

delay

delay: number

destination

destination: PartialObserver

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

lastValue

lastValue: T

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyNext

  • notifyNext(): void

  • Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SampleTimeSignature

  • Parameters

    • delay: number
    • Optional scheduler: Scheduler

    Returns Observable<T>

dispatchNotification

  • dispatchNotification<T>(state: any): void

  • Type parameters

    • T

    Parameters

    • state: any

    Returns void

sampleTime

  • method

    sampleTime

    owner

    Observable

    Type parameters

    • T

    Parameters

    • delay: number
    • Default value scheduler: Scheduler = async

    Returns Observable<T>

"node_modules/rxjs/src/operator/scan"

"node_modules/rxjs/src/operator/scan":

ScanOperator

ScanOperator:

constructor

  • new ScanOperator(accumulator: function, seed?: T | R): ScanOperator

  • Parameters

    • accumulator: function
        • (acc: R, value: T): R

        • Parameters

          • acc: R
          • value: T

          Returns R

    • Optional seed: T | R

    Returns ScanOperator

accumulator

accumulator: function

Type declaration

    • (acc: R, value: T): R

    • Parameters

      • acc: R
      • value: T

      Returns R

seed

seed: T | R

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

ScanSubscriber

ScanSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<R>
    • accumulator: function
        • (acc: R, value: T): R

        • Parameters

          • acc: R
          • value: T

          Returns R

    • Optional seed: T | R

    Returns ScanSubscriber

_seed

_seed: T | R

accumulator

accumulator: function

Type declaration

    • (acc: R, value: T): R

    • Parameters

      • acc: R
      • value: T

      Returns R

accumulatorSet

accumulatorSet: boolean

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

seed

seed:

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_tryNext

  • _tryNext(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

ScanSignature

  • __call<R>(accumulator: function, seed?: T | R): Observable<R>

  • Type parameters

    • R

    Parameters

    • accumulator: function
        • (acc: R, value: T): R

        • Parameters

          • acc: R
          • value: T

          Returns R

    • Optional seed: T | R

    Returns Observable<R>

scan

  • scan<T, R>(accumulator: function, seed?: T | R): Observable<R>

  • Applies an accumulation function over the source Observable, and returns each intermediate result, with an optional seed value.

    It's like reduce, but emits the current accumulation whenever the source emits a value.

    Combines together all values emitted on the source, using an accumulator function that knows how to join a new source value into the accumulation from the past. Is similar to reduce, but emits the intermediate accumulations.

    Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value for the accumulator. If no seed value is specified, the first item of the source is used as the seed.

    example

    Count the number of click events var clicks = Rx.Observable.fromEvent(document, 'click'); var ones = clicks.mapTo(1); var seed = 0; var count = ones.scan((acc, one) => acc + one, seed); count.subscribe(x => console.log(x));

    see

    expand

    see

    mergeScan

    see

    reduce

    method

    scan

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    • accumulator: function

      The accumulator function called on each source value.

        • (acc: R, value: T): R

        • Parameters

          • acc: R
          • value: T

          Returns R

    • Optional seed: T | R

    Returns Observable<R>

    An observable of the accumulated values.

"node_modules/rxjs/src/operator/share"

"node_modules/rxjs/src/operator/share":

ShareSignature

  • Returns Observable<T>

share

  • Returns a new Observable that multicasts (shares) the original Observable. As long as there is at least one Subscriber this Observable will be subscribed and emitting data. When all subscribers have unsubscribed it will unsubscribe from the source Observable. Because the Observable is multicasting it makes the stream hot. This is an alias for .publish().refCount().

    method

    share

    owner

    Observable

    Type parameters

    • T

    Returns Observable<T>

    an Observable that upon connection causes the source Observable to emit items to its Observers

shareSubjectFactory

  • shareSubjectFactory(): Subject<Object>

  • Returns Subject<Object>

"node_modules/rxjs/src/operator/single"

"node_modules/rxjs/src/operator/single":

SingleOperator

SingleOperator:

constructor

  • Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    • Optional source: Observable<T>

    Returns SingleOperator

predicate

predicate: function

Type declaration

    • (value: T, index: number, source: Observable<T>): boolean

    • Parameters

      Returns boolean

source

source: Observable<T>

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

SingleSubscriber

SingleSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

predicate

predicate: function

Type declaration

    • (value: T, index: number, source: Observable<T>): boolean

    • Parameters

      Returns boolean

seenValue

seenValue: boolean

singleValue

singleValue: T

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

applySingleValue

  • applySingleValue(value: T): void

  • Parameters

    • value: T

    Returns void

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

tryNext

  • tryNext(value: T): void

  • Parameters

    • value: T

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SingleSignature

  • Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    Returns Observable<T>

single

  • Returns an Observable that emits the single item emitted by the source Observable that matches a specified predicate, if that Observable emits one such item. If the source Observable emits more than one such item or no such items, notify of an IllegalArgumentException or NoSuchElementException respectively.

    throws

    {EmptyError} Delivers an EmptyError to the Observer's error callback if the Observable completes before any next notification was sent.

    method

    single

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Optional predicate: function
        • (value: T, index: number, source: Observable<T>): boolean

        • Parameters

          Returns boolean

    Returns Observable<T>

    an Observable that emits the single item emitted by the source Observable that matches the predicate. .

"node_modules/rxjs/src/operator/skip"

"node_modules/rxjs/src/operator/skip":

SkipOperator

SkipOperator:

constructor

  • Parameters

    • total: number

    Returns SkipOperator

total

total: number

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

SkipSubscriber

SkipSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

count

count: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

total

total: number

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(x: T): void

  • Parameters

    • x: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SkipSignature

  • Parameters

    • total: number

    Returns Observable<T>

skip

  • Returns an Observable that skips n items emitted by an Observable.

    method

    skip

    owner

    Observable

    Type parameters

    • T

    Parameters

    • total: number

    Returns Observable<T>

    an Observable that skips values emitted by the source Observable.

"node_modules/rxjs/src/operator/skipUntil"

"node_modules/rxjs/src/operator/skipUntil":

SkipUntilOperator

SkipUntilOperator:

constructor

notifier

notifier: Observable<any>

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

SkipUntilSubscriber

SkipUntilSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

hasValue

hasValue: boolean

isInnerStopped

isInnerStopped: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

  • notifyComplete(): void

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SkipUntilSignature

  • Parameters

    Returns Observable<T>

skipUntil

  • Returns an Observable that skips items emitted by the source Observable until a second Observable emits an item.

    method

    skipUntil

    owner

    Observable

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    an Observable that skips items from the source Observable until the second Observable emits an item, then emits the remaining items.

"node_modules/rxjs/src/operator/skipWhile"

"node_modules/rxjs/src/operator/skipWhile":

SkipWhileOperator

SkipWhileOperator:

constructor

  • Parameters

    • predicate: function
        • (value: T, index: number): boolean

        • Parameters

          • value: T
          • index: number

          Returns boolean

    Returns SkipWhileOperator

predicate

predicate: function

Type declaration

    • (value: T, index: number): boolean

    • Parameters

      • value: T
      • index: number

      Returns boolean

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

SkipWhileSubscriber

SkipWhileSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<T>
    • predicate: function
        • (value: T, index: number): boolean

        • Parameters

          • value: T
          • index: number

          Returns boolean

    Returns SkipWhileSubscriber

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

predicate

predicate: function

Type declaration

    • (value: T, index: number): boolean

    • Parameters

      • value: T
      • index: number

      Returns boolean

skipping

skipping: boolean

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

tryCallPredicate

  • tryCallPredicate(value: T): void

  • Parameters

    • value: T

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SkipWhileSignature

  • Parameters

    • predicate: function
        • (value: T, index: number): boolean

        • Parameters

          • value: T
          • index: number

          Returns boolean

    Returns Observable<T>

skipWhile

  • skipWhile<T>(predicate: function): Observable<T>

  • Returns an Observable that skips all items emitted by the source Observable as long as a specified condition holds true, but emits all further source items as soon as the condition becomes false.

    method

    skipWhile

    owner

    Observable

    Type parameters

    • T

    Parameters

    • predicate: function

      a function to test each item emitted from the source Observable.

        • (value: T, index: number): boolean

        • Parameters

          • value: T
          • index: number

          Returns boolean

    Returns Observable<T>

    an Observable that begins emitting items emitted by the source Observable when the specified predicate becomes false.

"node_modules/rxjs/src/operator/startWith"

"node_modules/rxjs/src/operator/startWith":

StartWithSignature

  • Parameters

    Returns Observable<T>

  • Parameters

    Returns Observable<T>

  • Parameters

    • v1: T
    • v2: T
    • v3: T
    • Optional scheduler: Scheduler

    Returns Observable<T>

  • Parameters

    • v1: T
    • v2: T
    • v3: T
    • v4: T
    • Optional scheduler: Scheduler

    Returns Observable<T>

  • Parameters

    • v1: T
    • v2: T
    • v3: T
    • v4: T
    • v5: T
    • Optional scheduler: Scheduler

    Returns Observable<T>

  • Parameters

    • v1: T
    • v2: T
    • v3: T
    • v4: T
    • v5: T
    • v6: T
    • Optional scheduler: Scheduler

    Returns Observable<T>

  • Parameters

    Returns Observable<T>

startWith

  • Returns an Observable that emits the items in a specified Iterable before it begins to emit items emitted by the source Observable.

    method

    startWith

    owner

    Observable

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    an Observable that emits the items in the specified Iterable and then emits the items emitted by the source Observable.

"node_modules/rxjs/src/operator/subscribeOn"

"node_modules/rxjs/src/operator/subscribeOn":

SubscribeOnSignature

  • Parameters

    • scheduler: Scheduler
    • Optional delay: number

    Returns Observable<T>

subscribeOn

  • Asynchronously subscribes Observers to this Observable on the specified Scheduler.

    method

    subscribeOn

    owner

    Observable

    Type parameters

    • T

    Parameters

    • scheduler: Scheduler
    • Default value delay: number = 0

    Returns Observable<T>

    the source Observable modified so that its subscriptions happen on the specified Scheduler .

"node_modules/rxjs/src/operator/switch"

"node_modules/rxjs/src/operator/switch":

SwitchOperator

SwitchOperator:

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

SwitchSubscriber

SwitchSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

active

active: number

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

innerSubscription

innerSubscription: Subscription

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

  • notifyComplete(): void

notifyError

  • notifyError(err: any): void

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

unsubscribeInner

  • unsubscribeInner(): void

  • Returns void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SwitchSignature

  • __call(): T

  • Returns T

_switch

  • _switch<T>(): T

  • Converts a higher-order Observable into a first-order Observable by subscribing to only the most recently emitted of those inner Observables.

    Flattens an Observable-of-Observables by dropping the previous inner Observable once a new one appears.

    switch subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, the output Observable subscribes to the inner Observable and begins emitting the items emitted by that. So far, it behaves like mergeAll. However, when a new inner Observable is emitted, switch unsubscribes from the earlier-emitted inner Observable and subscribes to the new inner Observable and begins emitting items from it. It continues to behave like this for subsequent inner Observables.

    example

    Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); // Each click event is mapped to an Observable that ticks every second var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000)); var switched = higherOrder.switch(); // The outcome is that switched is essentially a timer that restarts // on every click. The interval Observables from older clicks do not merge // with the current interval Observable. switched.subscribe(x => console.log(x));

    see

    combineAll

    see

    concatAll

    see

    exhaust

    see

    mergeAll

    see

    switchMap

    see

    switchMapTo

    see

    zipAll

    method

    switch

    name

    switch

    owner

    Observable

    Type parameters

    • T

    Returns T

    An Observable that emits the items emitted by the Observable most recently emitted by the source Observable.

"node_modules/rxjs/src/operator/switchMap"

"node_modules/rxjs/src/operator/switchMap":

SwitchMapOperator

SwitchMapOperator:

constructor

  • new SwitchMapOperator(project: function, resultSelector?: function): SwitchMapOperator

  • Parameters

    • project: function
    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns SwitchMapOperator

project

project: function

Type declaration

resultSelector

resultSelector: function

Type declaration

    • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

    • Parameters

      • outerValue: T
      • innerValue: I
      • outerIndex: number
      • innerIndex: number

      Returns R

call

  • call(subscriber: Subscriber<I>, source: any): any

  • Parameters

    Returns any

SwitchMapSubscriber

SwitchMapSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<I>
    • project: function
    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns SwitchMapSubscriber

destination

destination: PartialObserver

index

index: number

innerSubscription

innerSubscription: Subscription

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

project

project: function

Type declaration

resultSelector

resultSelector: function

Type declaration

    • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

    • Parameters

      • outerValue: T
      • innerValue: I
      • outerIndex: number
      • innerIndex: number

      Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_innerSub

  • _innerSub(result: any, value: T, index: number): void

  • Parameters

    • result: any
    • value: T
    • index: number

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_tryNotifyNext

  • _tryNotifyNext(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): void

  • Parameters

    • outerValue: T
    • innerValue: I
    • outerIndex: number
    • innerIndex: number

    Returns void

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, I>): void

  • Parameters

    • outerValue: T
    • innerValue: I
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, I>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SwitchMapSignature

  • __call<R>(project: function): Observable<R>
  • __call<I, R>(project: function, resultSelector: function): Observable<R>

  • Type parameters

    • R

    Parameters

    Returns Observable<R>

  • Type parameters

    • I

    • R

    Parameters

    • project: function
    • resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns Observable<R>

switchMap

  • switchMap<T, I, R>(project: function, resultSelector?: function): Observable<R>

  • Projects each source value to an Observable which is merged in the output Observable, emitting values only from the most recently projected Observable.

    Maps each value to an Observable, then flattens all of these inner Observables using switch.

    Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each time it observes one of these inner Observables, the output Observable begins emitting the items emitted by that inner Observable. When a new inner Observable is emitted, switchMap stops emitting items from the earlier-emitted inner Observable and begins emitting items from the new one. It continues to behave like this for subsequent inner Observables.

    example

    Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.switchMap((ev) => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

    see

    concatMap

    see

    exhaustMap

    see

    mergeMap

    see

    switch

    see

    switchMapTo

    method

    switchMap

    owner

    Observable

    Type parameters

    • T

    • I

    • R

    Parameters

    • project: function

      A function that, when applied to an item emitted by the source Observable, returns an Observable.

    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns Observable<R>

    An Observable that emits the result of applying the projection function (and the optional resultSelector) to each item emitted by the source Observable and taking only the values from the most recently projected inner Observable.

"node_modules/rxjs/src/operator/switchMapTo"

"node_modules/rxjs/src/operator/switchMapTo":

SwitchMapToOperator

SwitchMapToOperator:

constructor

  • Parameters

    • observable: Observable<I>
    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns SwitchMapToOperator

observable

observable: Observable<I>

resultSelector

resultSelector: function

Type declaration

    • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

    • Parameters

      • outerValue: T
      • innerValue: I
      • outerIndex: number
      • innerIndex: number

      Returns R

call

  • call(subscriber: Subscriber<I>, source: any): any

  • Parameters

    Returns any

SwitchMapToSubscriber

SwitchMapToSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<I>
    • inner: Observable<I>
    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns SwitchMapToSubscriber

destination

destination: PartialObserver

index

index: number

inner

inner: Observable<I>

innerSubscription

innerSubscription: Subscription

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

resultSelector

resultSelector: function

Type declaration

    • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

    • Parameters

      • outerValue: T
      • innerValue: I
      • outerIndex: number
      • innerIndex: number

      Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: any): void

  • Parameters

    • value: any

    Returns void

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, I>): void

  • Parameters

    • outerValue: T
    • innerValue: I
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, I>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

tryResultSelector

  • tryResultSelector(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): void

  • Parameters

    • outerValue: T
    • innerValue: I
    • outerIndex: number
    • innerIndex: number

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SwitchMapToSignature

  • Type parameters

    • R

    Parameters

    Returns Observable<R>

  • Type parameters

    • I

    • R

    Parameters

    • observable: ObservableInput
    • resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns Observable<R>

switchMapTo

  • Projects each source value to the same Observable which is flattened multiple times with switch in the output Observable.

    It's like switchMap, but maps each value always to the same inner Observable.

    Maps each source value to the given Observable innerObservable regardless of the source value, and then flattens those resulting Observables into one single Observable, which is the output Observable. The output Observables emits values only from the most recently emitted instance of innerObservable.

    example

    Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.switchMapTo(Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

    see

    concatMapTo

    see

    switch

    see

    switchMap

    see

    mergeMapTo

    method

    switchMapTo

    owner

    Observable

    Type parameters

    • T

    • I

    • R

    Parameters

    • innerObservable: Observable<I>

      An Observable to replace each value from the source Observable.

    • Optional resultSelector: function
        • (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R

        • Parameters

          • outerValue: T
          • innerValue: I
          • outerIndex: number
          • innerIndex: number

          Returns R

    Returns Observable<R>

    An Observable that emits items from the given innerObservable every time a value is emitted on the source Observable.

"node_modules/rxjs/src/operator/take"

"node_modules/rxjs/src/operator/take":

TakeOperator

TakeOperator:

constructor

  • Parameters

    • total: number

    Returns TakeOperator

total

total: number

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

TakeSubscriber

TakeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

count

count: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

total

total: number

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

TakeSignature

  • Parameters

    • total: number

    Returns Observable<T>

take

  • throws

    {ArgumentOutOfRangeError} When using take(i), it delivers an ArgumentOutOrRangeError to the Observer's error callback if i < 0.

    method

    take

    owner

    Observable

    Type parameters

    • T

    Parameters

    • total: number

    Returns Observable<T>

"node_modules/rxjs/src/operator/takeLast"

"node_modules/rxjs/src/operator/takeLast":

TakeLastOperator

TakeLastOperator:

constructor

  • Parameters

    • total: number

    Returns TakeLastOperator

total

total: number

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

TakeLastSubscriber

TakeLastSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

count

count: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

ring

ring: Array<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

total

total: number

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

TakeLastSignature

  • Parameters

    • total: number

    Returns Observable<T>

takeLast

  • throws

    {ArgumentOutOfRangeError} When using takeLast(i), it delivers an ArgumentOutOrRangeError to the Observer's error callback if i < 0.

    method

    takeLast

    owner

    Observable

    Type parameters

    • T

    Parameters

    • total: number

    Returns Observable<T>

"node_modules/rxjs/src/operator/takeUntil"

"node_modules/rxjs/src/operator/takeUntil":

TakeUntilOperator

TakeUntilOperator:

constructor

notifier

notifier: Observable<any>

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

TakeUntilSubscriber

TakeUntilSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

notifier

notifier: Observable<any>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

  • notifyComplete(): void

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

TakeUntilSignature

  • Parameters

    Returns Observable<T>

takeUntil

  • method

    takeUntil

    owner

    Observable

    Type parameters

    • T

    Parameters

    Returns Observable<T>

"node_modules/rxjs/src/operator/takeWhile"

"node_modules/rxjs/src/operator/takeWhile":

TakeWhileOperator

TakeWhileOperator:

constructor

  • Parameters

    • predicate: function
        • (value: T, index: number): boolean

        • Parameters

          • value: T
          • index: number

          Returns boolean

    Returns TakeWhileOperator

predicate

predicate: function

Type declaration

    • (value: T, index: number): boolean

    • Parameters

      • value: T
      • index: number

      Returns boolean

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

TakeWhileSubscriber

TakeWhileSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<T>
    • predicate: function
        • (value: T, index: number): boolean

        • Parameters

          • value: T
          • index: number

          Returns boolean

    Returns TakeWhileSubscriber

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

predicate

predicate: function

Type declaration

    • (value: T, index: number): boolean

    • Parameters

      • value: T
      • index: number

      Returns boolean

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

nextOrComplete

  • nextOrComplete(value: T, predicateResult: boolean): void

  • Parameters

    • value: T
    • predicateResult: boolean

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

TakeWhileSignature

  • Parameters

    • predicate: function
        • (value: T, index: number): boolean

        • Parameters

          • value: T
          • index: number

          Returns boolean

    Returns Observable<T>

takeWhile

  • takeWhile<T>(predicate: function): Observable<T>
  • method

    takeWhile

    owner

    Observable

    Type parameters

    • T

    Parameters

    • predicate: function
        • (value: T, index: number): boolean

        • Parameters

          • value: T
          • index: number

          Returns boolean

    Returns Observable<T>

"node_modules/rxjs/src/operator/throttle"

"node_modules/rxjs/src/operator/throttle":

ThrottleOperator

ThrottleOperator:

constructor

durationSelector

durationSelector: function

Type declaration

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

ThrottleSubscriber

ThrottleSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: Subscriber<T>

durationSelector

durationSelector: function

Type declaration

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

throttled

throttled: Subscription

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

emitAndThrottle

  • Parameters

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

  • notifyComplete(): void

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

tryDurationSelector

  • tryDurationSelector(value: T): void

  • Parameters

    • value: T

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

ThrottleSignature

  • __call(durationSelector: function): Observable<T>

throttle

  • throttle<T>(durationSelector: function): Observable<T>

"node_modules/rxjs/src/operator/throttleTime"

"node_modules/rxjs/src/operator/throttleTime":

ThrottleTimeOperator

ThrottleTimeOperator:

constructor

delay

delay: number

scheduler

scheduler: Scheduler

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

ThrottleTimeSubscriber

ThrottleTimeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

delay

delay: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

throttled

throttled: Subscription

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

clearThrottle

  • clearThrottle(): void

  • Returns void

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DispatchArg

DispatchArg:

subscriber

subscriber: ThrottleTimeSubscriber<T>

ThrottleTimeSignature

  • Parameters

    • dueTime: number
    • Optional scheduler: Scheduler

    Returns Observable<T>

dispatchNext

  • Type parameters

    • T

    Parameters

    Returns void

throttleTime

  • method

    throttleTime

    owner

    Observable

    Type parameters

    • T

    Parameters

    • delay: number
    • Default value scheduler: Scheduler = async

    Returns Observable<T>

"node_modules/rxjs/src/operator/timeInterval"

"node_modules/rxjs/src/operator/timeInterval":

TimeInterval

TimeInterval:

constructor

  • new TimeInterval(value: T, interval: number): TimeInterval

  • Parameters

    • value: T
    • interval: number

    Returns TimeInterval

interval

interval: number

value

value: T

TimeIntervalOperator

TimeIntervalOperator:

constructor

scheduler

scheduler: Scheduler

call

  • Parameters

    Returns any

TimeIntervalSubscriber

TimeIntervalSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

lastTime

lastTime: number

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

TimeIntervalSignature

timeInterval

  • method

    timeInterval

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Default value scheduler: Scheduler = async

    Returns Observable<TimeInterval<T>>

"node_modules/rxjs/src/operator/timeout"

"node_modules/rxjs/src/operator/timeout":

TimeoutOperator

TimeoutOperator:

constructor

  • new TimeoutOperator(waitFor: number, absoluteTimeout: boolean, errorToSend: any, scheduler: Scheduler): TimeoutOperator

  • Parameters

    • waitFor: number
    • absoluteTimeout: boolean
    • errorToSend: any
    • scheduler: Scheduler

    Returns TimeoutOperator

absoluteTimeout

absoluteTimeout: boolean

errorToSend

errorToSend: any

scheduler

scheduler: Scheduler

waitFor

waitFor: number

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

TimeoutSubscriber

TimeoutSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

_hasCompleted

_hasCompleted: boolean

_previousIndex

_previousIndex: number

absoluteTimeout

absoluteTimeout: boolean

destination

destination: PartialObserver

errorToSend

errorToSend: any

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

waitFor

waitFor: number

EMPTY

EMPTY: Subscription

hasCompleted

hasCompleted:

previousIndex

previousIndex:

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyTimeout

  • notifyTimeout(): void

  • Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

scheduleTimeout

  • scheduleTimeout(): void

  • Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

dispatchTimeout

  • dispatchTimeout(state: any): void

  • Parameters

    • state: any

    Returns void

TimeoutSignature

  • Parameters

    • due: number | Date
    • Optional errorToSend: any
    • Optional scheduler: Scheduler

    Returns Observable<T>

timeout

  • method

    timeout

    owner

    Observable

    Type parameters

    • T

    Parameters

    • due: number | Date
    • Default value errorToSend: any = null
    • Default value scheduler: Scheduler = async

    Returns Observable<T>

"node_modules/rxjs/src/operator/timeoutWith"

"node_modules/rxjs/src/operator/timeoutWith":

TimeoutWithOperator

TimeoutWithOperator:

constructor

  • Parameters

    • waitFor: number
    • absoluteTimeout: boolean
    • withObservable: Observable<any>
    • scheduler: Scheduler

    Returns TimeoutWithOperator

absoluteTimeout

absoluteTimeout: boolean

scheduler

scheduler: Scheduler

waitFor

waitFor: number

withObservable

withObservable: Observable<any>

call

  • call(subscriber: Subscriber<T>, source: any): any

  • Parameters

    Returns any

TimeoutWithSubscriber

TimeoutWithSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

_hasCompleted

_hasCompleted: boolean

_previousIndex

_previousIndex: number

absoluteTimeout

absoluteTimeout: boolean

destination

destination: Subscriber<T>

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

timeoutSubscription

timeoutSubscription: Subscription

waitFor

waitFor: number

withObservable

withObservable: Observable<any>

EMPTY

EMPTY: Subscription

hasCompleted

hasCompleted:

previousIndex

previousIndex:

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

handleTimeout

  • handleTimeout(): void

  • Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

scheduleTimeout

  • scheduleTimeout(): void

  • Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

dispatchTimeout

  • dispatchTimeout(state: any): void

  • Parameters

    • state: any

    Returns void

TimeoutWithSignature

  • Parameters

    Returns Observable<T>

  • Type parameters

    • R

    Parameters

    Returns Observable<T | R>

timeoutWith

  • method

    timeoutWith

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    Returns Observable<T | R>

"node_modules/rxjs/src/operator/timestamp"

"node_modules/rxjs/src/operator/timestamp":

Timestamp

Timestamp:

constructor

  • new Timestamp(value: T, timestamp: number): Timestamp

  • Parameters

    • value: T
    • timestamp: number

    Returns Timestamp

timestamp

timestamp: number

value

value: T

TimestampOperator

TimestampOperator:

constructor

scheduler

scheduler: Scheduler

call

  • Parameters

    Returns any

TimestampSubscriber

TimestampSubscriber:

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

TimestampSignature

timestamp

  • method

    timestamp

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Default value scheduler: Scheduler = async

    Returns Observable<Timestamp<T>>

"node_modules/rxjs/src/operator/toArray"

"node_modules/rxjs/src/operator/toArray":

ToArrayOperator

ToArrayOperator:

call

  • call(subscriber: Subscriber<T[]>, source: any): any

  • Parameters

    Returns any

ToArraySubscriber

ToArraySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

array

array: T[]

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(x: T): void

  • Parameters

    • x: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

ToArraySignature

  • Returns Observable<T[]>

toArray

  • method

    toArray

    owner

    Observable

    Type parameters

    • T

    Returns Observable<T[]>

"node_modules/rxjs/src/operator/toPromise"

"node_modules/rxjs/src/operator/toPromise":

ToPromiseSignature

  • __call(): Promise<T>
  • __call(PromiseCtor: PromiseConstructor): Promise<T>

  • Returns Promise<T>

  • Parameters

    • PromiseCtor: PromiseConstructor

    Returns Promise<T>

toPromise

  • toPromise<T>(PromiseCtor?: PromiseConstructor): Promise<T>
  • method

    toPromise

    owner

    Observable

    Type parameters

    • T

    Parameters

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<T>

"node_modules/rxjs/src/operator/window"

"node_modules/rxjs/src/operator/window":

WindowOperator

WindowOperator:

constructor

  • Parameters

    Returns WindowOperator

windowBoundaries

windowBoundaries: Observable<any>

call

  • Parameters

    Returns any

WindowSubscriber

WindowSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: Subscriber<Observable<T>>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

window

window: Subject<T>

windowBoundaries

windowBoundaries: Observable<any>

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, any>): void

  • Parameters

    • outerValue: T
    • innerValue: any
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, any>

    Returns void

openWindow

  • openWindow(): void

  • Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

WindowSignature

window

  • Branch out the source Observable values as a nested Observable whenever windowBoundaries emits.

    It's like buffer, but emits a nested Observable instead of an array.

    Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits connected, non-overlapping windows. It emits the current window and opens a new one whenever the Observable windowBoundaries emits an item. Because each window is an Observable, the output is a higher-order Observable.

    example

    In every window of 1 second each, emit at most 2 click events var clicks = Rx.Observable.fromEvent(document, 'click'); var interval = Rx.Observable.interval(1000); var result = clicks.window(interval) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

    see

    windowCount

    see

    {@link windowTime}

    see

    windowToggle

    see

    windowWhen

    see

    buffer

    method

    window

    owner

    Observable

    Type parameters

    • T

    Parameters

    • windowBoundaries: Observable<any>

      An Observable that completes the previous window and starts a new window.

    Returns Observable<Observable<T>>

    An Observable of windows, which are Observables emitting values of the source Observable.

"node_modules/rxjs/src/operator/windowCount"

"node_modules/rxjs/src/operator/windowCount":

WindowCountOperator

WindowCountOperator:

constructor

  • Parameters

    • windowSize: number
    • startWindowEvery: number

    Returns WindowCountOperator

startWindowEvery

startWindowEvery: number

windowSize

windowSize: number

call

  • Parameters

    Returns any

WindowCountSubscriber

WindowCountSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

count

count: number

destination

destination: Subscriber<Observable<T>>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

startWindowEvery

startWindowEvery: number

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

windowSize

windowSize: number

windows

windows: Subject<T>[]

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

WindowCountSignature

  • Parameters

    • windowSize: number
    • Optional startWindowEvery: number

    Returns Observable<Observable<T>>

windowCount

  • Branch out the source Observable values as a nested Observable with each nested Observable emitting at most windowSize values.

    It's like bufferCount, but emits a nested Observable instead of an array.

    Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits windows every startWindowEvery items, each containing no more than windowSize items. When the source Observable completes or encounters an error, the output Observable emits the current window and propagates the notification from the source Observable. If startWindowEvery is not provided, then new windows are started immediately at the start of the source and when each window completes with size windowSize.

    example

    Ignore every 3rd click event, starting from the first one var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowCount(3) .map(win => win.skip(1)) // skip first of every 3 clicks .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

    example

    Ignore every 3rd click event, starting from the third one var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowCount(2, 3) .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

    see

    window

    see

    {@link windowTime}

    see

    windowToggle

    see

    windowWhen

    see

    bufferCount

    method

    windowCount

    owner

    Observable

    Type parameters

    • T

    Parameters

    • windowSize: number

      The maximum number of values emitted by each window.

    • Default value startWindowEvery: number = 0

    Returns Observable<Observable<T>>

    An Observable of windows, which in turn are Observable of values.

"node_modules/rxjs/src/operator/windowTime"

"node_modules/rxjs/src/operator/windowTime":

WindowTimeOperator

WindowTimeOperator:

constructor

  • Parameters

    • windowTimeSpan: number
    • windowCreationInterval: number
    • scheduler: Scheduler

    Returns WindowTimeOperator

scheduler

scheduler: Scheduler

windowCreationInterval

windowCreationInterval: number

windowTimeSpan

windowTimeSpan: number

call

  • Parameters

    Returns any

WindowTimeSubscriber

WindowTimeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: Subscriber<Observable<T>>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

windowCreationInterval

windowCreationInterval: number

windowTimeSpan

windowTimeSpan: number

windows

windows: Subject<T>[]

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

closeWindow

  • closeWindow(window: Subject<T>): void

  • Parameters

    Returns void

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

openWindow

  • Returns Subject<T>

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

Context

Context:

action

action: Action<CreationState<T>>

subscription

subscription: Subscription

CreationState

CreationState:

scheduler

scheduler: Scheduler

subscriber

subscriber: WindowTimeSubscriber<T>

windowCreationInterval

windowCreationInterval: number

windowTimeSpan

windowTimeSpan: number

DispatchArg

DispatchArg:

context

context: Context<T>

subscriber

subscriber: WindowTimeSubscriber<T>

window

window: Subject<T>

TimeSpanOnlyState

TimeSpanOnlyState:

subscriber

subscriber: WindowTimeSubscriber<T>

window

window: Subject<any>

windowTimeSpan

windowTimeSpan: number

WindowTimeSignature

  • Parameters

    • windowTimeSpan: number
    • Optional windowCreationInterval: number
    • Optional scheduler: Scheduler

    Returns Observable<Observable<T>>

dispatchWindowClose

  • Type parameters

    • T

    Parameters

    Returns void

dispatchWindowCreation

  • Type parameters

    • T

    Parameters

    Returns void

dispatchWindowTimeSpanOnly

  • Type parameters

    • T

    Parameters

    Returns void

windowTime

  • Branch out the source Observable values as a nested Observable periodically in time.

    It's like bufferTime, but emits a nested Observable instead of an array.

    Returns an Observable that emits windows of items it collects from the source Observable. The output Observable starts a new window periodically, as determined by the windowCreationInterval argument. It emits each window after a fixed timespan, specified by the windowTimeSpan argument. When the source Observable completes or encounters an error, the output Observable emits the current window and propagates the notification from the source Observable. If windowCreationInterval is not provided, the output Observable starts a new window when the previous window of duration windowTimeSpan completes.

    example

    In every window of 1 second each, emit at most 2 click events var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

    example

    Every 5 seconds start a window 1 second long, and emit at most 2 click events per window var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000, 5000) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

    see

    window

    see

    windowCount

    see

    windowToggle

    see

    windowWhen

    see

    bufferTime

    method

    windowTime

    owner

    Observable

    Type parameters

    • T

    Parameters

    • windowTimeSpan: number

      The amount of time to fill each window.

    • Default value windowCreationInterval: number = null
    • Default value scheduler: Scheduler = async

    Returns Observable<Observable<T>>

    An observable of windows, which in turn are Observables.

"node_modules/rxjs/src/operator/windowToggle"

"node_modules/rxjs/src/operator/windowToggle":

WindowToggleOperator

WindowToggleOperator:

constructor

closingSelector

closingSelector: function

Type declaration

openings

openings: Observable<O>

call

  • Parameters

    Returns any

WindowToggleSubscriber

WindowToggleSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

closingSelector

closingSelector: function

Type declaration

contexts

contexts: WindowContext<T>[]

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

openSubscription

openSubscription: Subscription

openings

openings: Observable<O>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

closeWindow

  • closeWindow(index: number): void

  • Parameters

    • index: number

    Returns void

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

  • notifyError(err: any): void

  • Parameters

    • err: any

    Returns void

notifyNext

  • notifyNext(outerValue: any, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, any>): void

  • Parameters

    • outerValue: any
    • innerValue: any
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, any>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

WindowContext

WindowContext:

subscription

subscription: Subscription

window

window: Subject<T>

WindowToggleSignature

  • Type parameters

    • O

    Parameters

    Returns Observable<Observable<T>>

windowToggle

  • Branch out the source Observable values as a nested Observable starting from an emission from openings and ending when the output of closingSelector emits.

    It's like bufferToggle, but emits a nested Observable instead of an array.

    Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits windows that contain those items emitted by the source Observable between the time when the openings Observable emits an item and when the Observable returned by closingSelector emits an item.

    example

    Every other second, emit the click events from the next 500ms var clicks = Rx.Observable.fromEvent(document, 'click'); var openings = Rx.Observable.interval(1000); var result = clicks.windowToggle(openings, i => i % 2 ? Rx.Observable.interval(500) : Rx.Observable.empty() ).mergeAll(); result.subscribe(x => console.log(x));

    see

    window

    see

    windowCount

    see

    {@link windowTime}

    see

    windowWhen

    see

    bufferToggle

    method

    windowToggle

    owner

    Observable

    Type parameters

    • T

    • O

    Parameters

    • openings: Observable<O>

      An observable of notifications to start new windows.

    • closingSelector: function

      A function that takes the value emitted by the openings observable and returns an Observable, which, when it emits (either next or complete), signals that the associated window should complete.

    Returns Observable<Observable<T>>

    An observable of windows, which in turn are Observables.

"node_modules/rxjs/src/operator/windowWhen"

"node_modules/rxjs/src/operator/windowWhen":

WindowOperator

WindowOperator:

constructor

closingSelector

closingSelector: function

Type declaration

call

  • Parameters

    Returns any

WindowSubscriber

WindowSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

closingNotification

closingNotification: Subscription

closingSelector

closingSelector: function

Type declaration

destination

destination: Subscriber<Observable<T>>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

window

window: Subject<T>

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, any>): void

  • Parameters

    • outerValue: T
    • innerValue: any
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, any>

    Returns void

openWindow

  • Parameters

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

unsubscribeClosingNotification

  • unsubscribeClosingNotification(): void

  • Returns void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

WindowWhenSignature

windowWhen

  • Branch out the source Observable values as a nested Observable using a factory function of closing Observables to determine when to start a new window.

    It's like bufferWhen, but emits a nested Observable instead of an array.

    Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits connected, non-overlapping windows. It emits the current window and opens a new one whenever the Observable produced by the specified closingSelector function emits an item. The first window is opened immediately when subscribing to the output Observable.

    example

    Emit only the first two clicks events in every window of [1-5] random seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks .windowWhen(() => Rx.Observable.interval(1000 + Math.random() * 4000)) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

    see

    window

    see

    windowCount

    see

    {@link windowTime}

    see

    windowToggle

    see

    bufferWhen

    method

    windowWhen

    owner

    Observable

    Type parameters

    • T

    Parameters

    • closingSelector: function

      A function that takes no arguments and returns an Observable that signals (on either next or complete) when to close the previous window and start a new one.

    Returns Observable<Observable<T>>

    An observable of windows, which in turn are Observables.

"node_modules/rxjs/src/operator/withLatestFrom"

"node_modules/rxjs/src/operator/withLatestFrom":

WithLatestFromOperator

WithLatestFromOperator:

constructor

observables

observables: Observable<any>[]

project

project: function

Type declaration

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

WithLatestFromSubscriber

WithLatestFromSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

observables

observables: Observable<any>[]

project

project: function

Type declaration

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

toRespond

toRespond: number[]

values

values: any[]

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_tryProject

  • _tryProject(args: any[]): void

  • Parameters

    • args: any[]

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyComplete

  • notifyComplete(): void

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: R
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

WithLatestFromSignature

withLatestFrom

  • Combines the source Observable with other Observables to create an Observable whose values are calculated from the latest values of each, only when the source emits.

    Whenever the source Observable emits a value, it computes a formula using that value plus the latest values from other input Observables, then emits the output of that formula.

    withLatestFrom combines each value from the source Observable (the instance) with the latest values from the other input Observables only when the source emits a value, optionally using a project function to determine the value to be emitted on the output Observable. All input Observables must emit at least one value before the output Observable will emit a value.

    example

    On every click event, emit an array with the latest timer event plus the click event var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var result = clicks.withLatestFrom(timer); result.subscribe(x => console.log(x));

    see

    combineLatest

    method

    withLatestFrom

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    Returns Observable<R>

    An Observable of projected values from the most recent values from each input Observable, or an array of the most recent values from each input Observable.

"node_modules/rxjs/src/operator/zip"

"node_modules/rxjs/src/operator/zip":

StaticArrayIterator

StaticArrayIterator:

constructor

  • Parameters

    • array: T[]

    Returns StaticArrayIterator

array

array: T[]

index

index: number

length

length: number

__computed

hasCompleted

  • hasCompleted(): boolean

hasValue

  • hasValue(): boolean

next

  • next(value?: any): IteratorResult<T>

  • Parameters

    • Optional value: any

    Returns IteratorResult<T>

StaticIterator

StaticIterator:

constructor

  • Parameters

    • iterator: Iterator<T>

    Returns StaticIterator

iterator

iterator: Iterator<T>

nextResult

nextResult: IteratorResult<T>

hasCompleted

  • hasCompleted(): boolean

hasValue

  • hasValue(): boolean

next

  • next(): IteratorResult<T>

  • Returns IteratorResult<T>

ZipBufferIterator

ZipBufferIterator:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

buffer

buffer: T[]

destination

destination: PartialObserver

index

index: number

isComplete

isComplete: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

observable

observable: Observable<T>

parent

parent: ZipSubscriber<T, R>

stillUnsubscribed

stillUnsubscribed: boolean

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

hasCompleted

  • hasCompleted(): boolean

hasValue

  • hasValue(): boolean

next

  • next(): IteratorResult<T>

  • Returns IteratorResult<T>

notifyComplete

  • notifyComplete(): void

notifyError

notifyNext

  • notifyNext(outerValue: T, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

  • Parameters

    • outerValue: T
    • innerValue: any
    • outerIndex: number
    • innerIndex: number
    • innerSub: InnerSubscriber<T, R>

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

subscribe

  • Parameters

    • value: any
    • index: number

    Returns Subscription

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

ZipOperator

ZipOperator:

constructor

  • Parameters

    • Optional project: function
        • (...values: Array<any>): R

        • Parameters

          • Rest ...values: Array<any>

          Returns R

    Returns ZipOperator

project

project: function

Type declaration

    • (...values: Array<any>): R

    • Parameters

      • Rest ...values: Array<any>

      Returns R

call

  • call(subscriber: Subscriber<R>, source: any): any

  • Parameters

    Returns any

ZipSubscriber

ZipSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

  • Parameters

    • destination: Subscriber<R>
    • Optional project: function
        • (...values: Array<any>): R

        • Parameters

          • Rest ...values: Array<any>

          Returns R

    • Default value values: any = Object.create(null)

    Returns ZipSubscriber

active

active: number

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

iterators

iterators: LookAheadIterator<any>[]

project

project: function

Type declaration

    • (...values: Array<any>): R

    • Parameters

      • Rest ...values: Array<any>

      Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

values

values: any

EMPTY

EMPTY: Subscription

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_next

  • _next(value: any): void

  • Parameters

    • value: any

    Returns void

_tryProject

  • _tryProject(args: any[]): void

  • Parameters

    • args: any[]

    Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

checkIterators

  • checkIterators(): void

  • Returns void

complete

  • complete(): void

  • The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

    Returns void

error

  • error(err?: any): void

  • The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

    Parameters

    • Optional err: any

    Returns void

next

  • next(value?: T): void

  • The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

    Parameters

    • Optional value: T

    Returns void

notifyInactive

  • notifyInactive(): void

  • Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

unsubscribe

  • unsubscribe(): void

create

  • create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

  • A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

    Type parameters

    • T

    Parameters

    • Optional next: function
        • (x?: T): void

        • Parameters

          • Optional x: T

          Returns void

    • Optional error: function
        • (e?: any): void

        • Parameters

          • Optional e: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

    A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

LookAheadIterator

LookAheadIterator:

hasCompleted

  • hasCompleted(): boolean

  • Returns boolean

hasValue

  • hasValue(): boolean

  • Returns boolean

next

  • next(value?: any): IteratorResult<T>

  • Parameters

    • Optional value: any

    Returns IteratorResult<T>

return

  • return(value?: any): IteratorResult<T>

  • Parameters

    • Optional value: any

    Returns IteratorResult<T>

throw

  • throw(e?: any): IteratorResult<T>

  • Parameters

    • Optional e: any

    Returns IteratorResult<T>

ZipSignature

zipProto

  • method

    zip

    owner

    Observable

    Type parameters

    • R

    Parameters

    Returns Observable<R>

zipStatic

"node_modules/rxjs/src/operator/zipAll"

"node_modules/rxjs/src/operator/zipAll":

ZipAllSignature

  • Returns Observable<T[]>

  • Type parameters

    • R

    Parameters

    • Optional project: function
        • (...values: Array<T>): R

        • Parameters

          • Rest ...values: Array<T>

          Returns R

    Returns Observable<R>

zipAll

  • method

    zipAll

    owner

    Observable

    Type parameters

    • T

    • R

    Parameters

    • Optional project: function
        • (...values: Array<any>): R

        • Parameters

          • Rest ...values: Array<any>

          Returns R

    Returns Observable<R>

"node_modules/rxjs/src/scheduler/Action"

"node_modules/rxjs/src/scheduler/Action":

Action

Action:

constructor

  • new Action(unsubscribe?: function): Action

  • Parameters

    • Optional unsubscribe: function
        • (): void

        • Returns void

    Returns Action

delay

delay: number

error

error: any

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

state

state: T

work

work: function

Type declaration

EMPTY

EMPTY: Subscription

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

  • execute(): void

  • Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

schedule

  • schedule(state?: T, delay?: number): void

  • Parameters

    • Optional state: T
    • Optional delay: number

    Returns void

unsubscribe

  • unsubscribe(): void

  • Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

    Returns void

"node_modules/rxjs/src/scheduler/AnimationFrameAction"

"node_modules/rxjs/src/scheduler/AnimationFrameAction":

AnimationFrameAction

AnimationFrameAction:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

delay

delay: number

error

error: any

id

id: number

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

state

state: T

work

work: function

Type declaration

EMPTY

EMPTY: Subscription

_schedule

  • _schedule(state?: T, delay?: number): Action<T>

  • Parameters

    • Optional state: T
    • Default value delay: number = 0

    Returns Action<T>

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

  • execute(): void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

schedule

  • schedule(state?: T, delay?: number): Action<T>

  • Parameters

    • Optional state: T
    • Default value delay: number = 0

    Returns Action<T>

unsubscribe

  • unsubscribe(): void

  • Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

    Returns void

"node_modules/rxjs/src/scheduler/AnimationFrameScheduler"

"node_modules/rxjs/src/scheduler/AnimationFrameScheduler":

AnimationFrameScheduler

AnimationFrameScheduler:

actions

actions: QueueAction<any>[]

active

active: boolean

scheduledId

scheduledId: number

flush

  • flush(): void

now

  • now(): number

  • Returns number

schedule

  • schedule<T>(work: function, delay?: number, state?: T): Subscription

  • Type parameters

    • T

    Parameters

    • work: function
    • Default value delay: number = 0
    • Optional state: T

    Returns Subscription

scheduleLater

  • scheduleLater<T>(work: function, delay: number, state?: T): Action<T>

  • Type parameters

    • T

    Parameters

    • work: function
    • delay: number
    • Optional state: T

    Returns Action<T>

scheduleNow

  • scheduleNow<T>(work: function, state?: T): Action<T>

"node_modules/rxjs/src/scheduler/AsapAction"

"node_modules/rxjs/src/scheduler/AsapAction":

AsapAction

AsapAction:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

delay

delay: number

error

error: any

id

id: number

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

state

state: T

work

work: function

Type declaration

EMPTY

EMPTY: Subscription

_schedule

  • _schedule(state?: T, delay?: number): Action<T>

  • Parameters

    • Optional state: T
    • Default value delay: number = 0

    Returns Action<T>

_unsubscribe

  • _unsubscribe(): void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

  • execute(): void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

schedule

  • schedule(state?: T, delay?: number): Action<T>

  • Parameters

    • Optional state: T
    • Default value delay: number = 0

    Returns Action<T>

unsubscribe

  • unsubscribe(): void

  • Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

    Returns void

"node_modules/rxjs/src/scheduler/AsapScheduler"

"node_modules/rxjs/src/scheduler/AsapScheduler":

AsapScheduler

AsapScheduler:

actions

actions: QueueAction<any>[]

active

active: boolean

scheduledId

scheduledId: number

flush

  • flush(): void

now

  • now(): number

  • Returns number

schedule

  • schedule<T>(work: function, delay?: number, state?: T): Subscription

  • Type parameters

    • T

    Parameters

    • work: function
    • Default value delay: number = 0
    • Optional state: T

    Returns Subscription

scheduleLater

  • scheduleLater<T>(work: function, delay: number, state?: T): Action<T>

  • Type parameters

    • T

    Parameters

    • work: function
    • delay: number
    • Optional state: T

    Returns Action<T>

scheduleNow

  • scheduleNow<T>(work: function, state?: T): Action<T>

"node_modules/rxjs/src/scheduler/AsyncScheduler"

"node_modules/rxjs/src/scheduler/AsyncScheduler":

AsyncScheduler

AsyncScheduler:

actions

actions: QueueAction<any>[]

active

active: boolean

scheduledId

scheduledId: number

flush

  • flush(): void

now

  • now(): number

  • Returns number

schedule

  • schedule<T>(work: function, delay?: number, state?: T): Subscription

  • Type parameters

    • T

    Parameters

    • work: function
    • Default value delay: number = 0
    • Optional state: T

    Returns Subscription

scheduleLater

  • scheduleLater<T>(work: function, delay: number, state?: T): Action<T>

  • Type parameters

    • T

    Parameters

    • work: function
    • delay: number
    • Optional state: T

    Returns Action<T>

scheduleNow

  • scheduleNow<T>(work: function, state?: T): Action<T>

"node_modules/rxjs/src/scheduler/FutureAction"

"node_modules/rxjs/src/scheduler/FutureAction":

FutureAction

FutureAction:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

delay

delay: number

error

error: any

id

id: number

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

pending

pending: boolean

scheduler

scheduler: Scheduler

state

state: T

work

work: function

Type declaration

EMPTY

EMPTY: Subscription

_schedule

  • _schedule(state?: T, delay?: number): Action<T>

  • Parameters

    • Optional state: T
    • Default value delay: number = 0

    Returns Action<T>

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

  • execute(): void

  • Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

schedule

  • schedule(state?: T, delay?: number): Action<T>

  • Parameters

    • Optional state: T
    • Default value delay: number = 0

    Returns Action<T>

unsubscribe

  • unsubscribe(): void

  • Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

    Returns void

"node_modules/rxjs/src/scheduler/MiscJSDoc"

"node_modules/rxjs/src/scheduler/MiscJSDoc":

ActionDoc

ActionDoc:

A unit of work to be executed in a Scheduler. An action is typically created from within a Scheduler and an RxJS user does not need to concern themselves about creating and manipulating an Action.

interface Action extends Subscription {
  work: (state?: any) => void|Subscription;
  state?: any;
  delay?: number;
  schedule(state?: any, delay?: number): void;
  execute(): void;
  scheduler: Scheduler;
  error: any;
}
interface
name

Action

noimport

true

constructor

  • new ActionDoc(unsubscribe?: function): ActionDoc

  • Parameters

    • Optional unsubscribe: function
        • (): void

        • Returns void

    Returns ActionDoc

delay

delay: number

Represents the time (relative to the Scheduler's own clock) when this action should be executed.

type

{number}

error

error: any

A reference to the latest error that may have occurred during action execution.

type

{any}

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

The Scheduler which owns this action.

type

{Scheduler}

state

state: any

The current state. This is the object that will be given to the work method.

type

{any}

EMPTY

EMPTY: Subscription

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

  • execute(): void

  • Immediately executes this action and the work it contains.

    Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

schedule

  • schedule(state?: any, delay?: number): void

  • Schedules this action on its parent Scheduler for execution. May be passed some context object, state. May happen at some point in the future, according to the delay parameter, if specified.

    Parameters

    • Optional state: any
    • Optional delay: number

    Returns void

unsubscribe

  • unsubscribe(): void

  • Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

    Returns void

work

  • The function that represents the raw work to be executed on a Scheduler.

    Parameters

    • Optional state: any

    Returns void | Subscription

    A subscription in order to be able to unsubscribe the scheduled work.

"node_modules/rxjs/src/scheduler/QueueAction"

"node_modules/rxjs/src/scheduler/QueueAction":

QueueAction

QueueAction:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

delay

delay: number

error

error: any

id

id: number

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: Scheduler

state

state: T

work

work: function

Type declaration

EMPTY

EMPTY: Subscription

_schedule

  • _schedule(state?: T, delay?: number): Action<T>

  • Parameters

    • Optional state: T
    • Default value delay: number = 0

    Returns Action<T>

_unsubscribe

  • _unsubscribe(): void

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

  • execute(): void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

schedule

  • schedule(state?: T, delay?: number): Action<T>

  • Parameters

    • Optional state: T
    • Default value delay: number = 0

    Returns Action<T>

unsubscribe

  • unsubscribe(): void

  • Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

    Returns void

"node_modules/rxjs/src/scheduler/QueueScheduler"

"node_modules/rxjs/src/scheduler/QueueScheduler":

QueueScheduler

QueueScheduler:

actions

actions: QueueAction<any>[]

active

active: boolean

scheduledId

scheduledId: number

flush

  • flush(): void

  • Returns void

now

  • now(): number

  • Returns number

schedule

  • schedule<T>(work: function, delay?: number, state?: T): Subscription

  • Type parameters

    • T

    Parameters

    • work: function
    • Default value delay: number = 0
    • Optional state: T

    Returns Subscription

scheduleLater

  • scheduleLater<T>(work: function, delay: number, state?: T): Action<T>

  • Type parameters

    • T

    Parameters

    • work: function
    • delay: number
    • Optional state: T

    Returns Action<T>

scheduleNow

  • scheduleNow<T>(work: function, state?: T): Action<T>

  • Type parameters

    • T

    Parameters

    Returns Action<T>

"node_modules/rxjs/src/scheduler/VirtualTimeScheduler"

"node_modules/rxjs/src/scheduler/VirtualTimeScheduler":

VirtualAction

VirtualAction:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

calls

calls: number

delay

delay: number

error

error: any

index

index: number

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type

{boolean}

scheduler

scheduler: VirtualTimeScheduler

state

state: T

work

work: function

Type declaration

EMPTY

EMPTY: Subscription

add

  • Adds a tear down to be called during the unsubscribe() of this Subscription.

    If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

    If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

    Parameters

    • teardown: TeardownLogic

      The additional logic to execute on teardown.

    Returns Subscription

    Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

  • execute(): void

  • Returns void

remove

  • Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

    Parameters

    Returns void

schedule

  • Parameters

    • Optional state: T
    • Default value delay: number = 0

    Returns VirtualAction<T>

unsubscribe

  • unsubscribe(): void

VirtualTimeScheduler

VirtualTimeScheduler:

actions

actions: Action<any>[]

active

active: boolean

frame

frame: number

index

index: number

maxFrames

maxFrames: number

scheduledId

scheduledId: number

sorted

sorted: boolean

frameTimeFactor

frameTimeFactor: number

addAction

  • addAction<T>(action: Action<T>): void

  • Type parameters

    • T

    Parameters

    Returns void

flush

  • flush(): void

  • Returns void

now

  • now(): number

  • Returns number

schedule

  • schedule<T>(work: function, delay?: number, state?: T): Subscription

  • Type parameters

    • T

    Parameters

    • work: function
    • Default value delay: number = 0
    • Optional state: T

    Returns Subscription

"node_modules/rxjs/src/scheduler/animationFrame"

"node_modules/rxjs/src/scheduler/animationFrame":

animationFrame

animationFrame: AnimationFrameScheduler

"node_modules/rxjs/src/scheduler/asap"

"node_modules/rxjs/src/scheduler/asap":

asap

asap: AsapScheduler

"node_modules/rxjs/src/scheduler/async"

"node_modules/rxjs/src/scheduler/async":

async

async: AsyncScheduler

"node_modules/rxjs/src/scheduler/queue"

"node_modules/rxjs/src/scheduler/queue":

queue

queue: QueueScheduler

"node_modules/rxjs/src/symbol/iterator"

"node_modules/rxjs/src/symbol/iterator":

$$iterator

$$iterator: any

Symbol

Symbol: any

"node_modules/rxjs/src/symbol/observable"

"node_modules/rxjs/src/symbol/observable":

$$observable

$$observable: symbol

Symbol

Symbol: any

"node_modules/rxjs/src/symbol/rxSubscriber"

"node_modules/rxjs/src/symbol/rxSubscriber":

$$rxSubscriber

$$rxSubscriber: any

Symbol

Symbol: any

"node_modules/rxjs/src/testing/ColdObservable"

"node_modules/rxjs/src/testing/ColdObservable":

ColdObservable

ColdObservable:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

_isScalar

_isScalar: boolean

logSubscribedFrame

logSubscribedFrame: function

Type declaration

    • (): number

    • Returns number

logUnsubscribedFrame

logUnsubscribedFrame: function

Type declaration

    • (index: number): void

    • Parameters

      • index: number

      Returns void

messages

messages: TestMessage[]

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

subscriptions

subscriptions: SubscriptionLog[]

if

if: create

throw

throw: create

__computed

_subscribe

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

  • Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

    method

    lift

    Type parameters

    • R

    Parameters

    • operator: Operator<T, R>

      the operator defining the operation to take on the observable

    Returns Observable<R>

    a new observable with the Operator applied

scheduleMessages

  • scheduleMessages(subscriber: Subscriber<any>): void

  • Parameters

    Returns void

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

create

  • Creates a new cold Observable by calling the Observable constructor

    Type parameters

    • T

    Parameters

    Returns Observable<T>

    a new cold observable

"node_modules/rxjs/src/testing/HotObservable"

"node_modules/rxjs/src/testing/HotObservable":

HotObservable

HotObservable:

We need this JSDoc comment for affecting ESDoc.

ignore
extends

{Ignored}

constructor

_isScalar

_isScalar: boolean

destination

destination: Observer<T>

dispatching

dispatching: boolean

errorValue

errorValue: any

hasCompleted

hasCompleted: boolean

hasErrored

hasErrored: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

logSubscribedFrame

logSubscribedFrame: function

Type declaration

    • (): number

    • Returns number

logUnsubscribedFrame

logUnsubscribedFrame: function

Type declaration

    • (index: number): void

    • Parameters

      • index: number

      Returns void

messages

messages: TestMessage[]

observers

observers: Observer<T>[]

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<T>

subscriptions

subscriptions: SubscriptionLog[]

if

if: create

throw

throw: create

__computed

_complete

  • _complete(): void

  • Returns void

_error

  • _error(err: any): void

  • Parameters

    • err: any

    Returns void

_finalComplete

  • _finalComplete(): void

_finalError

  • _finalError(err: any): void

  • Parameters

    • err: any

    Returns void

_finalNext

  • _finalNext(value: T): void

  • Parameters

    • value: T

    Returns void

_next

  • _next(value: T): void

  • Parameters

    • value: T

    Returns void

_subscribe

_unsubscribe

  • _unsubscribe(): void

  • Returns void

add

asObservable

complete

  • complete(): void

  • Returns void

error

  • error(err?: any): void

  • Parameters

    • Optional err: any

    Returns void

forEach

  • forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>
  • method

    forEach

    Parameters

    • next: function

      a handler for each value emitted by the observable

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • Optional PromiseCtor: PromiseConstructor

    Returns Promise<void>

    a promise that either resolves on observable completion or rejects with the handled error

lift

next

  • next(value: T): void

  • Parameters

    • value: T

    Returns void

remove

  • Parameters

    Returns void

setup

  • setup(): void

  • Returns void

subscribe

  • Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

    method

    subscribe

    Parameters

    • Optional observerOrNext: PartialObserver | function

      (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.

    • Optional error: function

      (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled

        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function

      (optional) a handler for a terminal event resulting from successful completion.

        • (): void

        • Returns void

    Returns Subscription

    a subscription reference to the registered handlers

unsubscribe

  • unsubscribe(): void

create

"node_modules/rxjs/src/testing/SubscriptionLog"

"node_modules/rxjs/src/testing/SubscriptionLog":

SubscriptionLog

SubscriptionLog:

constructor

  • new SubscriptionLog(subscribedFrame: number, unsubscribedFrame?: number): SubscriptionLog

  • Parameters

    • subscribedFrame: number
    • Default value unsubscribedFrame: number = Number.POSITIVE_INFINITY

    Returns SubscriptionLog

subscribedFrame

subscribedFrame: number

unsubscribedFrame

unsubscribedFrame: number

"node_modules/rxjs/src/testing/SubscriptionLoggable"

"node_modules/rxjs/src/testing/SubscriptionLoggable":

SubscriptionLoggable

SubscriptionLoggable:

scheduler

scheduler: Scheduler

subscriptions

subscriptions: SubscriptionLog[]

logSubscribedFrame

  • logSubscribedFrame(): number

  • Returns number

logUnsubscribedFrame

  • logUnsubscribedFrame(index: number): void

  • Parameters

    • index: number

    Returns void

"node_modules/rxjs/src/testing/TestMessage"

"node_modules/rxjs/src/testing/TestMessage":

TestMessage

TestMessage:

frame

frame: number

notification

notification: Notification<any>

"node_modules/rxjs/src/testing/TestScheduler"

"node_modules/rxjs/src/testing/TestScheduler":

TestScheduler

TestScheduler:

constructor

  • Parameters

    • assertDeepEqual: function
        • (actual: any, expected: any): boolean | void

        • Parameters

          • actual: any
          • expected: any

          Returns boolean | void

    Returns TestScheduler

actions

actions: Action<any>[]

active

active: boolean

assertDeepEqual

assertDeepEqual: function

Type declaration

    • (actual: any, expected: any): boolean | void

    • Parameters

      • actual: any
      • expected: any

      Returns boolean | void

coldObservables

coldObservables: ColdObservable<any>[]

flushTests

flushTests: FlushableTest[]

frame

frame: number

hotObservables

hotObservables: HotObservable<any>[]

index

index: number

maxFrames

maxFrames: number

scheduledId

scheduledId: number

sorted

sorted: boolean

frameTimeFactor

frameTimeFactor: number

addAction

  • addAction<T>(action: Action<T>): void

  • Type parameters

    • T

    Parameters

    Returns void

createColdObservable

  • createColdObservable<T>(marbles: string, values?: any, error?: any): Observable<T>

  • Type parameters

    • T

    Parameters

    • marbles: string
    • Optional values: any
    • Optional error: any

    Returns Observable<T>

createHotObservable

  • createHotObservable<T>(marbles: string, values?: any, error?: any): Subject<T>

  • Type parameters

    • T

    Parameters

    • marbles: string
    • Optional values: any
    • Optional error: any

    Returns Subject<T>

createTime

  • createTime(marbles: string): number

  • Parameters

    • marbles: string

    Returns number

expectObservable

  • expectObservable(observable: Observable<any>, unsubscriptionMarbles?: string): object

  • Parameters

    • observable: Observable<any>
    • Default value unsubscriptionMarbles: string = null

    Returns object

expectSubscriptions

flush

  • flush(): void

materializeInnerObservable

  • Parameters

    Returns TestMessage[]

now

  • now(): number

schedule

  • schedule<T>(work: function, delay?: number, state?: T): Subscription

parseMarbles

  • parseMarbles(marbles: string, values?: any, errorValue?: any, materializeInnerObservables?: boolean): TestMessage[]

  • Parameters

    • marbles: string
    • Optional values: any
    • Optional errorValue: any
    • Default value materializeInnerObservables: boolean = false

    Returns TestMessage[]

parseMarblesAsSubscriptions

  • Parameters

    • marbles: string

    Returns SubscriptionLog

FlushableTest

FlushableTest:

actual

actual: any[]

expected

expected: any[]

ready

ready: boolean

observableToBeFn

observableToBeFn: function

Type declaration

    • (marbles: string, values?: any, errorValue?: any): void

    • Parameters

      • marbles: string
      • Optional values: any
      • Optional errorValue: any

      Returns void

subscriptionLogsToBeFn

subscriptionLogsToBeFn: function

Type declaration

    • (marbles: string | string[]): void

    • Parameters

      • marbles: string | string[]

      Returns void

"node_modules/rxjs/src/util/AnimationFrame"

"node_modules/rxjs/src/util/AnimationFrame":

RequestAnimationFrameDefinition

RequestAnimationFrameDefinition:

constructor

cancelAnimationFrame

cancelAnimationFrame: function

Type declaration

    • (handle: number): void

    • Parameters

      • handle: number

      Returns void

requestAnimationFrame

requestAnimationFrame: function

Type declaration

    • (cb: function): number

    • Parameters

      • cb: function
          • (): void

          • Returns void

      Returns number

AnimationFrame

AnimationFrame: RequestAnimationFrameDefinition

"node_modules/rxjs/src/util/ArgumentOutOfRangeError"

"node_modules/rxjs/src/util/ArgumentOutOfRangeError":

ArgumentOutOfRangeError

ArgumentOutOfRangeError:

An error thrown when an element was queried at a certain index of an Observable, but no such index or position exists in that sequence.

see

elementAt

see

take

see

takeLast

class

ArgumentOutOfRangeError

constructor

Error

Error: ErrorConstructor

message

message: string

name

name: string

stack

stack: string

"node_modules/rxjs/src/util/EmptyError"

"node_modules/rxjs/src/util/EmptyError":

EmptyError

EmptyError:

An error thrown when an Observable or a sequence was queried but has no elements.

see

first

see

last

see

single

class

EmptyError

constructor

  • Returns EmptyError

Error

Error: ErrorConstructor

message

message: string

name

name: string

stack

stack: string

"node_modules/rxjs/src/util/FastMap"

"node_modules/rxjs/src/util/FastMap":

FastMap

FastMap:

values

values: Object

clear

  • clear(): void

  • Returns void

delete

  • delete(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

forEach

  • forEach(cb: function, thisArg?: any): void

  • Parameters

    • cb: function
        • (value: any, key: any): void

        • Parameters

          • value: any
          • key: any

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key: string): any

  • Parameters

    • key: string

    Returns any

set

  • set(key: string, value: any): FastMap

  • Parameters

    • key: string
    • value: any

    Returns FastMap

"node_modules/rxjs/src/util/Immediate"

"node_modules/rxjs/src/util/Immediate":

ImmediateDefinition

ImmediateDefinition:

constructor

  • Parameters

    • root: any

    Returns ImmediateDefinition

clearImmediate

clearImmediate: function

Type declaration

    • (handle: number): void

    • Parameters

      • handle: number

      Returns void

currentlyRunningATask

currentlyRunningATask: boolean

nextHandle

nextHandle: number

root

root: any

setImmediate

setImmediate: function

Type declaration

    • (cb: function): number

    • Parameters

      • cb: function
          • (): void

          • Returns void

      Returns number

tasksByHandle

tasksByHandle: any

addFromSetImmediateArguments

  • addFromSetImmediateArguments(args: any[]): number

  • Parameters

    • args: any[]

    Returns number

canUseMessageChannel

  • canUseMessageChannel(): boolean

  • Returns boolean

canUsePostMessage

  • canUsePostMessage(): boolean

  • Returns boolean

canUseProcessNextTick

  • canUseProcessNextTick(): boolean

  • Returns boolean

canUseReadyStateChange

  • canUseReadyStateChange(): boolean

  • Returns boolean

createMessageChannelSetImmediate

  • createMessageChannelSetImmediate(): setImmediate

  • Returns setImmediate

createPostMessageSetImmediate

  • createPostMessageSetImmediate(): setImmediate

  • Returns setImmediate

createProcessNextTickSetImmediate

  • createProcessNextTickSetImmediate(): setImmediate

  • Returns setImmediate

createReadyStateChangeSetImmediate

  • createReadyStateChangeSetImmediate(): setImmediate

  • Returns setImmediate

createSetTimeoutSetImmediate

  • createSetTimeoutSetImmediate(): setImmediate

  • Returns setImmediate

identify

  • identify(o: any): string

  • Parameters

    • o: any

    Returns string

partiallyApplied

  • partiallyApplied(handler: any, ...args: any[]): result

  • Parameters

    • handler: any
    • Rest ...args: any[]

    Returns result

runIfPresent

  • runIfPresent(handle: any): void

  • Parameters

    • handle: any

    Returns void

Immediate

Immediate: ImmediateDefinition

"node_modules/rxjs/src/util/Map"

"node_modules/rxjs/src/util/Map":

Map

Map: any

"node_modules/rxjs/src/util/MapPolyfill"

"node_modules/rxjs/src/util/MapPolyfill":

MapPolyfill

MapPolyfill:

_keys

_keys: any[]

_values

_values: any[]

size

size: number

clear

  • clear(): void

  • Returns void

delete

  • delete(key: any): boolean

  • Parameters

    • key: any

    Returns boolean

forEach

  • forEach(cb: Function, thisArg: any): void

  • Parameters

    • cb: Function
    • thisArg: any

    Returns void

get

  • get(key: any): any

  • Parameters

    • key: any

    Returns any

set

  • Parameters

    • key: any
    • value: any

    Returns MapPolyfill

"node_modules/rxjs/src/util/ObjectUnsubscribedError"

"node_modules/rxjs/src/util/ObjectUnsubscribedError":

ObjectUnsubscribedError

ObjectUnsubscribedError:

An error thrown when an action is invalid because the object has been unsubscribed.

see

Subject

see

BehaviorSubject

class

ObjectUnsubscribedError

constructor

Error

Error: ErrorConstructor

message

message: string

name

name: string

stack

stack: string

"node_modules/rxjs/src/util/UnsubscriptionError"

"node_modules/rxjs/src/util/UnsubscriptionError":

UnsubscriptionError

UnsubscriptionError:

An error thrown when one or more errors have occurred during the unsubscribe of a Subscription.

constructor

  • Parameters

    • errors: any[]

    Returns UnsubscriptionError

errors

errors: any[]

Error

Error: ErrorConstructor

message

message: string

name

name: string

stack

stack: string

"node_modules/rxjs/src/util/applyMixins"

"node_modules/rxjs/src/util/applyMixins":

applyMixins

  • applyMixins(derivedCtor: any, baseCtors: any[]): void

  • Parameters

    • derivedCtor: any
    • baseCtors: any[]

    Returns void

"node_modules/rxjs/src/util/assign"

"node_modules/rxjs/src/util/assign":

Object

Object: any

assign

assign: function

Type declaration

    • (target: Object, ...sources: Array<Object>): Object

    • Parameters

      • target: Object
      • Rest ...sources: Array<Object>

      Returns Object

"node_modules/rxjs/src/util/errorObject"

"node_modules/rxjs/src/util/errorObject":

errorObject

errorObject: object

e

e: object

Type declaration

"node_modules/rxjs/src/util/isArray"

"node_modules/rxjs/src/util/isArray":

isArray

isArray: isArray

"node_modules/rxjs/src/util/isDate"

"node_modules/rxjs/src/util/isDate":

isDate

  • isDate(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

"node_modules/rxjs/src/util/isFunction"

"node_modules/rxjs/src/util/isFunction":

isFunction

  • isFunction(x: any): boolean

  • Parameters

    • x: any

    Returns boolean

"node_modules/rxjs/src/util/isNumeric"

"node_modules/rxjs/src/util/isNumeric":

isNumeric

  • isNumeric(val: any): boolean

  • Parameters

    • val: any

    Returns boolean

"node_modules/rxjs/src/util/isObject"

"node_modules/rxjs/src/util/isObject":

isObject

  • isObject(x: any): boolean

  • Parameters

    • x: any

    Returns boolean

"node_modules/rxjs/src/util/isPromise"

"node_modules/rxjs/src/util/isPromise":

isPromise

  • isPromise<T>(value: any | Promise<T>): boolean

  • Type parameters

    • T

    Parameters

    • value: any | Promise<T>

    Returns boolean

"node_modules/rxjs/src/util/isScheduler"

"node_modules/rxjs/src/util/isScheduler":

isScheduler

  • isScheduler<T>(value: any): boolean

  • Type parameters

    • T

    Parameters

    • value: any

    Returns boolean

"node_modules/rxjs/src/util/noop"

"node_modules/rxjs/src/util/noop":

noop

  • noop(): void

  • Returns void

"node_modules/rxjs/src/util/not"

"node_modules/rxjs/src/util/not":

not

  • not(pred: Function, thisArg: any): Function

  • Parameters

    • pred: Function
    • thisArg: any

    Returns Function

"node_modules/rxjs/src/util/root"

"node_modules/rxjs/src/util/root":

NodeJS

NodeJS:

Global

Global:

global

global: any

window

window: any

exports

exports: any

freeExports

freeExports: any

freeGlobal

freeGlobal: Global

freeModule

freeModule: any

global

global: Global

module

module: any

root

root: any

objectTypes

objectTypes: object

boolean

boolean: boolean

function

function: boolean

number

number: boolean

object

object: boolean

string

string: boolean

undefined

undefined: boolean

"node_modules/rxjs/src/util/subscribeToResult"

"node_modules/rxjs/src/util/subscribeToResult":

subscribeToResult

  • Type parameters

    • T

    • R

    Parameters

    • outerSubscriber: OuterSubscriber<T, R>
    • result: any
    • Optional outerValue: T
    • Optional outerIndex: number

    Returns Subscription

"node_modules/rxjs/src/util/throwError"

"node_modules/rxjs/src/util/throwError":

throwError

  • throwError(e: any): void

  • Parameters

    • e: any

    Returns void

"node_modules/rxjs/src/util/toSubscriber"

"node_modules/rxjs/src/util/toSubscriber":

toSubscriber

  • Type parameters

    • T

    Parameters

    • Optional nextOrObserver: PartialObserver | function
    • Optional error: function
        • (error: any): void

        • Parameters

          • error: any

          Returns void

    • Optional complete: function
        • (): void

        • Returns void

    Returns Subscriber<T>

"node_modules/rxjs/src/util/tryCatch"

"node_modules/rxjs/src/util/tryCatch":

tryCatchTarget

tryCatchTarget: Function

tryCatch

  • tryCatch<T>(fn: T): T

  • Type parameters

    • T: Function

    Parameters

    • fn: T

    Returns T

tryCatcher

  • tryCatcher(): any

  • Returns any

"node_modules/zone.js/lib/browser/browser"

"node_modules/zone.js/lib/browser/browser":

XHROptions

XHROptions:

aborted

aborted: boolean

args

args: any[]

delay

delay: number

Delay in milliseconds when the Task will run.

isPeriodic

isPeriodic: boolean

A periodic [MacroTask] is such which get automatically rescheduled after it is executed.

target

target: any

XHR_TASK

XHR_TASK: string

_global

_global: Global | Window

blockingMethods

blockingMethods: Array<string>

clear

clear: string

set

set: string

patchXHR

  • patchXHR(window: any): void

  • Parameters

    • window: any

    Returns void

"node_modules/zone.js/lib/browser/define-property"

"node_modules/zone.js/lib/browser/define-property":

_create

_create: create

_defineProperty

_defineProperty: defineProperty

_getOwnPropertyDescriptor

_getOwnPropertyDescriptor: getOwnPropertyDescriptor

unconfigurablesKey

unconfigurablesKey: string

_redefineProperty

  • _redefineProperty(obj: any, prop: any, desc: any): any

  • Parameters

    • obj: any
    • prop: any
    • desc: any

    Returns any

isUnconfigurable

  • isUnconfigurable(obj: any, prop: any): any

  • Parameters

    • obj: any
    • prop: any

    Returns any

propertyPatch

  • propertyPatch(): void

  • Returns void

rewriteDescriptor

  • rewriteDescriptor(obj: any, prop: any, desc: any): any

  • Parameters

    • obj: any
    • prop: any
    • desc: any

    Returns any

"node_modules/zone.js/lib/browser/event-target"

"node_modules/zone.js/lib/browser/event-target":

EVENT_TARGET

EVENT_TARGET: string

NO_EVENT_TARGET

NO_EVENT_TARGET: Array<string>

WTF_ISSUE_555

WTF_ISSUE_555: string

eventTargetPatch

  • eventTargetPatch(_global: any): void

  • Parameters

    • _global: any

    Returns void

"node_modules/zone.js/lib/browser/property-descriptor"

"node_modules/zone.js/lib/browser/property-descriptor":

eventNames

eventNames: Array<string>

unboundKey

unboundKey: string

canPatchViaPropertyDescriptor

  • canPatchViaPropertyDescriptor(): boolean

  • Returns boolean

patchViaCapturingAllTheEvents

  • patchViaCapturingAllTheEvents(): void

  • Returns void

propertyDescriptorPatch

  • propertyDescriptorPatch(_global: any): void

  • Parameters

    • _global: any

    Returns void

"node_modules/zone.js/lib/browser/register-element"

"node_modules/zone.js/lib/browser/register-element":

registerElementPatch

  • registerElementPatch(_global: any): void

  • Parameters

    • _global: any

    Returns void

"node_modules/zone.js/lib/browser/websocket"

"node_modules/zone.js/lib/browser/websocket":

apply

  • apply(_global: any): void

  • Parameters

    • _global: any

    Returns void

"node_modules/zone.js/lib/common/timers"

"node_modules/zone.js/lib/common/timers":

TimerOptions

TimerOptions:

args

args: any[]

delay

delay: number

Delay in milliseconds when the Task will run.

handleId

handleId: number

isPeriodic

isPeriodic: boolean

A periodic [MacroTask] is such which get automatically rescheduled after it is executed.

patchTimer

  • patchTimer(window: any, setName: string, cancelName: string, nameSuffix: string): void

  • Parameters

    • window: any
    • setName: string
    • cancelName: string
    • nameSuffix: string

    Returns void

"node_modules/zone.js/lib/common/utils"

"node_modules/zone.js/lib/common/utils":

ListenerTaskMeta

ListenerTaskMeta:

delay

delay: number

Delay in milliseconds when the Task will run.

eventName

eventName: string

handler

handler: EventListenerOrEventListenerObject

isPeriodic

isPeriodic: boolean

A periodic [MacroTask] is such which get automatically rescheduled after it is executed.

name

name: string

target

target: any

useCapturing

useCapturing: boolean

ADD_EVENT_LISTENER

ADD_EVENT_LISTENER: string

EVENT_TASKS

EVENT_TASKS: string

REMOVE_EVENT_LISTENER

REMOVE_EVENT_LISTENER: string

SYMBOL_ADD_EVENT_LISTENER

SYMBOL_ADD_EVENT_LISTENER: string

SYMBOL_REMOVE_EVENT_LISTENER

SYMBOL_REMOVE_EVENT_LISTENER: string

WorkerGlobalScope

WorkerGlobalScope: any

Suppress closure compiler errors about unknown 'process' variable

fileoverview
suppress

{undefinedVars}

_global

_global: Global | Window

isBrowser

isBrowser: boolean

isNode

isNode: boolean

isWebWorker

isWebWorker: boolean

originalInstanceKey

originalInstanceKey: string

zoneSymbol

zoneSymbol: function

Type declaration

    • (name: string): string

    • Parameters

      • name: string

      Returns string

attachRegisteredEvent

  • attachRegisteredEvent(target: any, eventTask: Task): void

  • Parameters

    • target: any
    • eventTask: Task

    Returns void

bindArguments

  • bindArguments(args: any[], source: string): any[]

  • Parameters

    • args: any[]
    • source: string

    Returns any[]

cancelEventListener

  • cancelEventListener(eventTask: Task): void

  • Parameters

    • eventTask: Task

    Returns void

createNamedFn

  • createNamedFn(name: string, delegate: function): Function

  • Parameters

    • name: string
    • delegate: function
        • (self: any, args: any[]): any

        • Parameters

          • self: any
          • args: any[]

          Returns any

    Returns Function

findExistingRegisteredTask

  • findExistingRegisteredTask(target: any, handler: any, name: string, capture: boolean, remove: boolean): Task

  • Parameters

    • target: any
    • handler: any
    • name: string
    • capture: boolean
    • remove: boolean

    Returns Task

patchClass

  • patchClass(className: any): void

  • Parameters

    • className: any

    Returns void

patchEventTargetMethods

  • patchEventTargetMethods(obj: any): boolean

  • Parameters

    • obj: any

    Returns boolean

patchMethod

  • patchMethod(target: any, name: string, patchFn: function): Function

  • Parameters

    • target: any
    • name: string
    • patchFn: function
        • (delegate: Function, delegateName: string, name: string): function

        • Parameters

          • delegate: Function
          • delegateName: string
          • name: string

          Returns function

            • (self: any, args: any[]): any

            • Parameters

              • self: any
              • args: any[]

              Returns any

    Returns Function

patchOnProperties

  • patchOnProperties(obj: any, properties: string[]): void

  • Parameters

    • obj: any
    • properties: string[]

    Returns void

patchProperty

  • patchProperty(obj: any, prop: any): void

  • Parameters

    • obj: any
    • prop: any

    Returns void

patchPrototype

  • patchPrototype(prototype: any, fnNames: any): void

  • Parameters

    • prototype: any
    • fnNames: any

    Returns void

scheduleEventListener

  • scheduleEventListener(eventTask: Task): any

  • Parameters

    • eventTask: Task

    Returns any

zoneAwareAddEventListener

  • zoneAwareAddEventListener(self: any, args: any[]): any

  • Parameters

    • self: any
    • args: any[]

    Returns any

zoneAwareRemoveEventListener

  • zoneAwareRemoveEventListener(self: any, args: any[]): void

  • Parameters

    • self: any
    • args: any[]

    Returns void

"node_modules/zone.js/lib/jasmine/jasmine"

"node_modules/zone.js/lib/jasmine/jasmine":

SET_TIMEOUT

SET_TIMEOUT: string

_global

_global: Global | Window

"node_modules/zone.js/lib/node/node"

"node_modules/zone.js/lib/node/node":

_global

_global: Global | Window

clear

clear: string

crypto

crypto: any

set

set: string

shouldPatchGlobalTimers

shouldPatchGlobalTimers: boolean

timers

timers: any

"node_modules/zone.js/lib/zone"

"node_modules/zone.js/lib/zone":

EventTask

EventTask:

callback

callback: Function

Function which needs to be executed by the Task after the [Zone.currentTask] has been set to the current task.

cancelFn

cancelFn: function

Represents the default work which needs to be done to un-schedule the Task from the VM. Not all Tasks are cancelable, and therefore this method is optional.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

    • (task: Task): void

    • Parameters

      • task: Task

      Returns void

data

data: TaskData

Task specific options associated with the current task. This is passed to the scheduleFn.

invoke

invoke: Function

The Function to be used by the VM on entering the [Task]. This function will delegate to [Zone.runTask] and delegate to callback.

runCount

runCount: number

Number of times the task has been executed, or -1 if canceled.

scheduleFn

scheduleFn: function

Represents the default work which needs to be done to schedule the Task by the VM.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

    • (task: Task): void

    • Parameters

      • task: Task

      Returns void

source

source: string

Debug string representing the API which requested the scheduling of the task.

type

type: TaskType

Task type: microTask, macroTask, eventTask.

zone

zone: Zone
type

{Zone} The zone which will be used to invoke the callback. The Zone is captured at the time of Task creation.

MacroTask

MacroTask:

callback

callback: Function

Function which needs to be executed by the Task after the [Zone.currentTask] has been set to the current task.

cancelFn

cancelFn: function

Represents the default work which needs to be done to un-schedule the Task from the VM. Not all Tasks are cancelable, and therefore this method is optional.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

    • (task: Task): void

    • Parameters

      • task: Task

      Returns void

data

data: TaskData

Task specific options associated with the current task. This is passed to the scheduleFn.

invoke

invoke: Function

The Function to be used by the VM on entering the [Task]. This function will delegate to [Zone.runTask] and delegate to callback.

runCount

runCount: number

Number of times the task has been executed, or -1 if canceled.

scheduleFn

scheduleFn: function

Represents the default work which needs to be done to schedule the Task by the VM.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

    • (task: Task): void

    • Parameters

      • task: Task

      Returns void

source

source: string

Debug string representing the API which requested the scheduling of the task.

type

type: TaskType

Task type: microTask, macroTask, eventTask.

zone

zone: Zone
type

{Zone} The zone which will be used to invoke the callback. The Zone is captured at the time of Task creation.

MicroTask

MicroTask:

callback

callback: Function

Function which needs to be executed by the Task after the [Zone.currentTask] has been set to the current task.

cancelFn

cancelFn: function

Represents the default work which needs to be done to un-schedule the Task from the VM. Not all Tasks are cancelable, and therefore this method is optional.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

    • (task: Task): void

    • Parameters

      • task: Task

      Returns void

data

data: TaskData

Task specific options associated with the current task. This is passed to the scheduleFn.

invoke

invoke: Function

The Function to be used by the VM on entering the [Task]. This function will delegate to [Zone.runTask] and delegate to callback.

runCount

runCount: number

Number of times the task has been executed, or -1 if canceled.

scheduleFn

scheduleFn: function

Represents the default work which needs to be done to schedule the Task by the VM.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

    • (task: Task): void

    • Parameters

      • task: Task

      Returns void

source

source: string

Debug string representing the API which requested the scheduling of the task.

type

type: TaskType

Task type: microTask, macroTask, eventTask.

zone

zone: Zone
type

{Zone} The zone which will be used to invoke the callback. The Zone is captured at the time of Task creation.

Task

Task:

Represents work which is executed with a clean stack.

Tasks are used in Zones to mark work which is performed on clean stack frame. There are three kinds of task. [MicroTask], [MacroTask], and [EventTask].

A JS VM can be modeled as a [MicroTask] queue, [MacroTask] queue, and [EventTask] set.

  • [MicroTask] queue represents a set of tasks which are executing right after the current stack frame becomes clean and before a VM yield. All [MicroTask]s execute in order of insertion before VM yield and the next [MacroTask] is executed.
  • [MacroTask] queue represents a set of tasks which are executed one at a time after each VM yield. The queue is order by time, and insertions can happen in any location.
  • [EventTask] is a set of tasks which can at any time be inserted to the end of the [MacroTask] queue. This happens when the event fires.

callback

callback: Function

Function which needs to be executed by the Task after the [Zone.currentTask] has been set to the current task.

cancelFn

cancelFn: function

Represents the default work which needs to be done to un-schedule the Task from the VM. Not all Tasks are cancelable, and therefore this method is optional.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

    • (task: Task): void

    • Parameters

      • task: Task

      Returns void

data

data: TaskData

Task specific options associated with the current task. This is passed to the scheduleFn.

invoke

invoke: Function

The Function to be used by the VM on entering the [Task]. This function will delegate to [Zone.runTask] and delegate to callback.

runCount

runCount: number

Number of times the task has been executed, or -1 if canceled.

scheduleFn

scheduleFn: function

Represents the default work which needs to be done to schedule the Task by the VM.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

    • (task: Task): void

    • Parameters

      • task: Task

      Returns void

source

source: string

Debug string representing the API which requested the scheduling of the task.

type

type: TaskType

Task type: microTask, macroTask, eventTask.

zone

zone: Zone
type

{Zone} The zone which will be used to invoke the callback. The Zone is captured at the time of Task creation.

TaskData

TaskData:

delay

delay: number

Delay in milliseconds when the Task will run.

isPeriodic

isPeriodic: boolean

A periodic [MacroTask] is such which get automatically rescheduled after it is executed.

Zone

Zone:

Zone is a mechanism for intercepting and keeping track of asynchronous work.

A Zone is a global object which is configured with rules about how to intercept and keep track of the asynchronous callbacks. Zone has these responsibilities:

  1. Intercept asynchronous task scheduling
  2. Wrap callbacks for error-handling and zone tracking across async operations.
  3. Provide a way to attach data to zones
  4. Provide a context specific last frame error handling
  5. (Intercept blocking methods)

A zone by itself does not do anything, instead it relies on some other code to route existing platform API through it. (The zone library ships with code which monkey patches all of the browsers's asynchronous API and redirects them through the zone for interception.)

In its simplest form a zone allows one to intercept the scheduling and calling of asynchronous operations, and execute additional code before as well as after the asynchronous task. The rules of interception are configured using [ZoneConfig]. There can be many different zone instances in a system, but only one zone is active at any given time which can be retrieved using [Zone#current].

Callback Wrapping

An important aspect of the zones is that they should persist across asynchronous operations. To achieve this, when a future work is scheduled through async API, it is necessary to capture, and subsequently restore the current zone. For example if a code is running in zone b and it invokes setTimeout to scheduleTask work later, the setTimeout method needs to 1) capture the current zone and 2) wrap the wrapCallback in code which will restore the current zone b once the wrapCallback executes. In this way the rules which govern the current code are preserved in all future asynchronous tasks. There could be a different zone c which has different rules and is associated with different asynchronous tasks. As these tasks are processed, each asynchronous wrapCallback correctly restores the correct zone, as well as preserves the zone for future asynchronous callbacks.

Example: Suppose a browser page consist of application code as well as third-party advertisement code. (These two code bases are independent, developed by different mutually unaware developers.) The application code may be interested in doing global error handling and so it configures the app zone to send all of the errors to the server for analysis, and then executes the application in the app zone. The advertising code is interested in the same error processing but it needs to send the errors to a different third-party. So it creates the ads zone with a different error handler. Now both advertising as well as application code create many asynchronous operations, but the [Zone] will ensure that all of the asynchronous operations created from the application code will execute in app zone with its error handler and all of the advertisement code will execute in the ads zone with its error handler. This will not only work for the async operations created directly, but also for all subsequent asynchronous operations.

If you think of chain of asynchronous operations as a thread of execution (bit of a stretch) then [Zone#current] will act as a thread local variable.

Asynchronous operation scheduling

In addition to wrapping the callbacks to restore the zone, all operations which cause a scheduling of work for later are routed through the current zone which is allowed to intercept them by adding work before or after the wrapCallback as well as using different means of achieving the request. (Useful for unit testing, or tracking of requests). In some instances such as setTimeout the wrapping of the wrapCallback and scheduling is done in the same wrapCallback, but there are other examples such as Promises where the then wrapCallback is wrapped, but the execution of then in triggered by Promise scheduling resolve work.

Fundamentally there are three kinds of tasks which can be scheduled:

  1. [MicroTask] used for doing work right after the current task. This is non-cancelable which is guaranteed to run exactly once and immediately.
  2. [MacroTask] used for doing work later. Such as setTimeout. This is typically cancelable which is guaranteed to execute at least once after some well understood delay.
  3. [EventTask] used for listening on some future event. This may execute zero or more times, with an unknown delay.

Each asynchronous API is modeled and routed through one of these APIs.

[MicroTask]

[MicroTask]s represent work which will be done in current VM turn as soon as possible, before VM yielding.

[TimerTask]

[TimerTask]s represents work which will be done after some delay. (Sometimes the delay is approximate such as on next available animation frame). Typically these methods include: setTimeout, setImmediate, setInterval, requestAnimationFrame, and all browser specif variants.

[EventTask]

[EventTask]s represents a request to create a listener on an event. Unlike the other task events may never be executed, but typically execute more then once. There is no queue of events, rather their callbacks are unpredictable both in order and time.

Global Error Handling

Composability

Zones can be composed together through [Zone.fork()]. A child zone may create its own set of rules. A child zone is expected to either:

  1. Delegate the interception to a parent zone, and optionally add before and after wrapCallback hook.s 2) Or process the request itself without delegation.

Composability allows zones to keep their concerns clean. For example a top most zone may chose to handle error handling, while child zones may chose to do user action tracking.

Root Zone

At the start the browser will run in a special root zone, which is configure to behave exactly like the platform, making any existing code which is not-zone aware behave as expected. All zones are children of the root zone.

name

name: string
returns

The Zone name (useful for debugging)

parent

parent: Zone
returns

The parent Zone.

cancelTask

  • cancelTask(task: Task): any

  • Allows the zone to intercept canceling of scheduled Task.

    The interception is configured using [ZoneSpec.onCancelTask]. The default canceler invokes the [Task.cancelFn].

    Parameters

    • task: Task

    Returns any

fork

  • fork(zoneSpec: ZoneSpec): Zone

  • Used to create a child zone.

    Parameters

    • zoneSpec: ZoneSpec

      A set of rules which the child zone should follow.

    Returns Zone

    A new child zone.

get

  • get(key: string): any

  • Returns a value associated with the key.

    If the current zone does not have a key, the request is delegated to the parent zone. Use [ZoneSpec.properties] to configure the set of properties asseciated with the current zone.

    Parameters

    • key: string

      The key to retrieve.

    Returns any

    Tha value for the key, or undefined if not found.

run

  • run<T>(callback: Function, applyThis?: any, applyArgs?: any[], source?: string): T

  • Invokes a function in a given zone.

    The invocation of callback can be intercepted be declaring [ZoneSpec.onInvoke].

    Type parameters

    • T

    Parameters

    • callback: Function

      The function to invoke.

    • Optional applyThis: any
    • Optional applyArgs: any[]
    • Optional source: string

      A unique debug location of the API being invoked.

    Returns T

    Value from the callback function.

runGuarded

  • runGuarded<T>(callback: Function, applyThis?: any, applyArgs?: any[], source?: string): T

  • Invokes a function in a given zone and catches any exceptions.

    Any exceptions thrown will be forwarded to [Zone.HandleError].

    The invocation of callback can be intercepted be declaring [ZoneSpec.onInvoke]. The handling of exceptions can intercepted by declaring [ZoneSpec.handleError].

    Type parameters

    • T

    Parameters

    • callback: Function

      The function to invoke.

    • Optional applyThis: any
    • Optional applyArgs: any[]
    • Optional source: string

      A unique debug location of the API being invoked.

    Returns T

    Value from the callback function.

runTask

  • runTask(task: Task, applyThis?: any, applyArgs?: any): any

  • Execute the Task by restoring the [Zone.currentTask] in the Task's zone.

    Parameters

    • task: Task
    • Optional applyThis: any
    • Optional applyArgs: any

    Returns any

scheduleEventTask

  • scheduleEventTask(source: string, callback: Function, data: TaskData, customSchedule: function, customCancel: function): EventTask

  • Parameters

    • source: string
    • callback: Function
    • data: TaskData
    • customSchedule: function
        • (task: Task): void

        • Parameters

          • task: Task

          Returns void

    • customCancel: function
        • (task: Task): void

        • Parameters

          • task: Task

          Returns void

    Returns EventTask

scheduleMacroTask

  • scheduleMacroTask(source: string, callback: Function, data: TaskData, customSchedule: function, customCancel: function): MacroTask

  • Parameters

    • source: string
    • callback: Function
    • data: TaskData
    • customSchedule: function
        • (task: Task): void

        • Parameters

          • task: Task

          Returns void

    • customCancel: function
        • (task: Task): void

        • Parameters

          • task: Task

          Returns void

    Returns MacroTask

scheduleMicroTask

  • scheduleMicroTask(source: string, callback: Function, data?: TaskData, customSchedule?: function): MicroTask

  • Parameters

    • source: string
    • callback: Function
    • Optional data: TaskData
    • Optional customSchedule: function
        • (task: Task): void

        • Parameters

          • task: Task

          Returns void

    Returns MicroTask

wrap

  • wrap(callback: Function, source: string): Function

  • Wraps a callback function in a new function which will properly restore the current zone upon invocation.

    The wrapped function will properly forward this as well as arguments to the callback.

    Before the function is wrapped the zone can intercept the callback by declaring [ZoneSpec.onIntercept].

    Parameters

    • callback: Function

      the function which will be wrapped in the zone.

    • source: string

      A unique debug location of the API being wrapped.

    Returns Function

    A function which will invoke the callback through [Zone.runGuarded].

ZoneDelegate

ZoneDelegate:

A delegate when intercepting zone operations.

A ZoneDelegate is needed because a child zone can't simply invoke a method on a parent zone. For example a child zone wrap can't just call parent zone wrap. Doing so would create a callback which is bound to the parent zone. What we are interested is intercepting the callback before it is bound to any zone. Furthermore, we also need to pass the targetZone (zone which received the original request) to the delegate.

The ZoneDelegate methods mirror those of Zone with an addition of extra targetZone argument in the method signature. (The original Zone which received the request.) Some methods are renamed to prevent confusion, because they have slightly different semantics and arguments.

  • wrap => intercept: The wrap method delegates to intercept. The wrap method returns a callback which will run in a given zone, where as intercept allows wrapping the callback so that additional code can be run before and after, but does not associated the callback with the zone.

  • run => invoke: The run method delegates to invoke to perform the actual execution of the callback. The run method switches to new zone; saves and restores the Zone.current; and optionally performs error handling. The invoke is not responsible for error handling, or zone management.

    Not every method is usually overwritten in the child zone, for this reason the ZoneDelegate stores the closest zone which overwrites this behavior along with the closest ZoneSpec.

    NOTE: We have tried to make this API analogous to Event bubbling with target and current properties.

    Note: The ZoneDelegate treats ZoneSpec as class. This allows the ZoneSpec to use its this to store internal state.

zone

zone: Zone

cancelTask

  • cancelTask(targetZone: Zone, task: Task): any

  • Parameters

    • targetZone: Zone
    • task: Task

    Returns any

fork

  • fork(targetZone: Zone, zoneSpec: ZoneSpec): Zone

  • Parameters

    • targetZone: Zone
    • zoneSpec: ZoneSpec

    Returns Zone

handleError

  • handleError(targetZone: Zone, error: any): boolean

  • Parameters

    • targetZone: Zone
    • error: any

    Returns boolean

hasTask

  • Parameters

    Returns void

intercept

  • intercept(targetZone: Zone, callback: Function, source: string): Function

  • Parameters

    • targetZone: Zone
    • callback: Function
    • source: string

    Returns Function

invoke

  • invoke(targetZone: Zone, callback: Function, applyThis: any, applyArgs: any[], source: string): any

  • Parameters

    • targetZone: Zone
    • callback: Function
    • applyThis: any
    • applyArgs: any[]
    • source: string

    Returns any

invokeTask

  • invokeTask(targetZone: Zone, task: Task, applyThis: any, applyArgs: any): any

  • Parameters

    • targetZone: Zone
    • task: Task
    • applyThis: any
    • applyArgs: any

    Returns any

scheduleTask

  • scheduleTask(targetZone: Zone, task: Task): Task

  • Parameters

    • targetZone: Zone
    • task: Task

    Returns Task

ZoneSpec

ZoneSpec:

Provides a way to configure the interception of zone events.

Only the name property is required (all other are optional).

name

name: string

The name of the zone. Usefull when debugging Zones.

onCancelTask

onCancelTask: function

Allows interception of task cancelation.

param

Delegate which performs the parent [ZoneSpec] operation.

param

The current [Zone] where the current interceptor has beed declared.

param

The [Zone] which originally received the request.

param

The argument passed into the cancelTask method.

Type declaration

    • (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, task: Task): any

    • Parameters

      • parentZoneDelegate: ZoneDelegate
      • currentZone: Zone
      • targetZone: Zone
      • task: Task

      Returns any

onFork

onFork: function

Allows the interception of zone forking.

When the zone is being forked, the request is forwarded to this method for interception.

param

Delegate which performs the parent [ZoneSpec] operation.

param

The current [Zone] where the current interceptor has beed declared.

param

The [Zone] which originally received the request.

param

The argument passed into the fork method.

Type declaration

    • (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, zoneSpec: ZoneSpec): Zone

    • Parameters

      • parentZoneDelegate: ZoneDelegate
      • currentZone: Zone
      • targetZone: Zone
      • zoneSpec: ZoneSpec

      Returns Zone

onHandleError

onHandleError: function

Allows interception of the error handling.

param

Delegate which performs the parent [ZoneSpec] operation.

param

The current [Zone] where the current interceptor has beed declared.

param

The [Zone] which originally received the request.

param

The argument passed into the handleError method.

Type declaration

    • (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, error: any): boolean

    • Parameters

      • parentZoneDelegate: ZoneDelegate
      • currentZone: Zone
      • targetZone: Zone
      • error: any

      Returns boolean

onHasTask

onHasTask: function

Notifies of changes to the task queue empty status.

param

Delegate which performs the parent [ZoneSpec] operation.

param

The current [Zone] where the current interceptor has beed declared.

param

The [Zone] which originally received the request.

param

Type declaration

    • (delegate: ZoneDelegate, current: Zone, target: Zone, hasTaskState: HasTaskState): void

    • Parameters

      • delegate: ZoneDelegate
      • current: Zone
      • target: Zone
      • hasTaskState: HasTaskState

      Returns void

onIntercept

onIntercept: function

Allows interception of the wrapping of the callback.

param

Delegate which performs the parent [ZoneSpec] operation.

param

The current [Zone] where the current interceptor has beed declared.

param

The [Zone] which originally received the request.

param

The argument passed into the warp method.

param

The argument passed into the warp method.

Type declaration

    • (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, delegate: Function, source: string): Function

    • Parameters

      • parentZoneDelegate: ZoneDelegate
      • currentZone: Zone
      • targetZone: Zone
      • delegate: Function
      • source: string

      Returns Function

onInvoke

onInvoke: function

Allows interception of the callback invocation.

param

Delegate which performs the parent [ZoneSpec] operation.

param

The current [Zone] where the current interceptor has beed declared.

param

The [Zone] which originally received the request.

param

The argument passed into the run method.

param

The argument passed into the run method.

param

The argument passed into the run method.

param

The argument passed into the run method.

Type declaration

    • (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, delegate: Function, applyThis: any, applyArgs: any[], source: string): any

    • Parameters

      • parentZoneDelegate: ZoneDelegate
      • currentZone: Zone
      • targetZone: Zone
      • delegate: Function
      • applyThis: any
      • applyArgs: any[]
      • source: string

      Returns any

onInvokeTask

onInvokeTask: function

Type declaration

    • (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, task: Task, applyThis: any, applyArgs: any): any

    • Parameters

      • parentZoneDelegate: ZoneDelegate
      • currentZone: Zone
      • targetZone: Zone
      • task: Task
      • applyThis: any
      • applyArgs: any

      Returns any

onScheduleTask

onScheduleTask: function

Allows interception of task scheduling.

param

Delegate which performs the parent [ZoneSpec] operation.

param

The current [Zone] where the current interceptor has beed declared.

param

The [Zone] which originally received the request.

param

The argument passed into the scheduleTask method.

Type declaration

    • (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, task: Task): Task

    • Parameters

      • parentZoneDelegate: ZoneDelegate
      • currentZone: Zone
      • targetZone: Zone
      • task: Task

      Returns Task

properties

properties: object

A set of properties to be associated with Zone. Use [Zone.get] to retrive them.

Type declaration

  • [key: string]: any

ZoneType

ZoneType:

current

current: Zone
returns

Returns the current [Zone]. Returns the current zone. The only way to change the current zone is by invoking a run() method, which will update the current zone for the duration of the run method callback.

currentTask

currentTask: Task
returns

The task associated with the current execution.

AmbientZone

AmbientZone: Zone
internal

AmbientZoneDelegate

AmbientZoneDelegate: ZoneDelegate
internal

HasTaskState

HasTaskState: object

Type declaration

  • change: TaskType
  • eventTask: boolean
  • macroTask: boolean
  • microTask: boolean

TaskType

TaskType: string

Task type: microTask, macroTask, eventTask.

"node_modules/zone.js/lib/zone-spec/async-test"

"node_modules/zone.js/lib/zone-spec/async-test":

"node_modules/zone.js/lib/zone-spec/fake-async-test"

"node_modules/zone.js/lib/zone-spec/fake-async-test":

"node_modules/zone.js/lib/zone-spec/long-stack-trace"

"node_modules/zone.js/lib/zone-spec/long-stack-trace":

"node_modules/zone.js/lib/zone-spec/sync-test"

"node_modules/zone.js/lib/zone-spec/sync-test":

"node_modules/zone.js/lib/zone-spec/wtf"

"node_modules/zone.js/lib/zone-spec/wtf":

"src/engine"

"src/engine":

Runtime

Runtime:

constructor

bootstrapApp

bootstrapApp: string

bootstrapButton

bootstrapButton: string

options

options: HapiEngineConfig

angularScript

  • angularScript(config: any): string

bootstrapFunction

  • bootstrapFunction(config: any): string

buildClientScripts

  • buildClientScripts(html: string, options: any): string

prebootScript

  • prebootScript(config: any): string

render

  • render(template: string, context: any, done: Function): void

  • Parameters

    • template: string
    • context: any
    • done: Function

    Returns void

hapiEngine

hapiEngine:

constructor

helpers

helpers: any

partials

partials: any

compile

  • compile(template: any, options: any, next: any): any

  • Parameters

    • template: any
    • options: any
    • next: any

    Returns any

registerHelper

  • registerHelper(name: any, helper: any): void

registerPartial

  • registerPartial(name: any, partial: any): void

HapiEngineExtraOptions

HapiEngineExtraOptions:

bootloader

bootloader: any

client

client: boolean

reuseProviders

reuseProviders: boolean

selector

selector: string

serializedCmp

serializedCmp: string

server

server: boolean

HapiEngineConfig

HapiEngineConfig: any

HAPI_PLATFORM

HAPI_PLATFORM: any

disposeHapiAngularApp

  • disposeHapiAngularApp(): void

disposeHapiPlatform

  • disposeHapiPlatform(): void

HAPI_ANGULAR_APP

HAPI_ANGULAR_APP: object

directives

directives: null

providers

providers: null

template

template: null

"src/ts-hoek"

"src/ts-hoek":

applyToDefaults

  • applyToDefaults(defaults: any, options?: any, isNullOverride?: any): any

  • Parameters

    • defaults: any
    • Optional options: any
    • Optional isNullOverride: any

    Returns any

assert

  • assert(condition: any, ...args: Array<any>): void

  • Parameters

    • condition: any
    • Rest ...args: Array<any>

    Returns void

clone

  • clone(obj: any, seen?: any): any

  • Parameters

    • obj: any
    • Optional seen: any

    Returns any

merge

  • merge(target: any, source: any, isNullOverride: any, isMergeArrays: any): any

  • Parameters

    • target: any
    • source: any
    • isNullOverride: any
    • isMergeArrays: any

    Returns any

stringify

  • stringify(...args: Array<any>): any

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc